Skip to content

Commit

Permalink
## 1.22
Browse files Browse the repository at this point in the history
- Allow Sphinx explicitly to write in parallel.
- Fixed crash when documenting ParamSpecArgs

## 1.21.7

- Fixed a bug where if a class has an attribute and a constructor argument with the same name, the constructor argument
  type would be rendered incorrectly (issue 308)

- Fixed napoleon handling of numpy docstrings with no specified return type.

## 1.21.6

- Fix a `Field list ends without a blank line` warning (issue 305).

## 1.21.5

- More robust determination of rtype location / fix issue 302

## 1.21.4

- Improvements to the location of the return type

## 1.21.3

- Use format_annotation to render class attribute type annotations

## 1.21.2

- Fix overloads support

## 1.21.1

- Fix spacing between `:rtype:` and directives

## 1.21

- Handle types from types module
- If module is \_io, use io instead
- Put rtype before examples or usage section
- Remove redundant return type for attributes
- Handle collections.abc.Callable as well as typing.Callable
- Put Literal args in code blocks

## 1.20.2

- Fix Optional role to be data.

## 1.20.1

- Fixed default options not displaying for parameters without type hints.

## 1.20

- Use hatchling instead of setuptools
- Add support for typing.ParamSpec
- Allow star prefixes for parameter names in docstring

## 1.19.2

- Fix incorrect domain used for collections.abc.Callable.

## 1.19.1

- Fix bug for recursive type alias.

## 1.19.0

- Support for CPython 3.11, no longer adds `Optional` when the argument is default per
  [recommendation from PEP-484](tox-dev/sphinx-autodoc-typehints#247).

## 1.18.3

- Support and require `nptyping>=2.1.2`

## 1.18.2

- Support and require `nptyping>=2.1.1`

## 1.18.1

- Fix mocked module import not working when used as guarded import

## 1.18.0

- Support and require `nptyping>=2`
- Handle `UnionType`

## 1.17.1

- Mark it as requiring `nptyping<2`

## 1.17.0

- Add `typehints_use_rtype` option
- Handles `TypeError` when getting source code via inspect

## 1.16.0

- Add support for type subscriptions with multiple elements, where one or more elements are tuples; e.g.,
  `nptyping.NDArray[(Any, ...), nptyping.Float]`
- Fix bug for arbitrary types accepting singleton subscriptions; e.g., `nptyping.Float[64]`
- Resolve forward references
- Expand and better handle `TypeVar`
- Add intershpinx reference link for `...` to `Ellipsis` (as is just an alias)

## 1.15.3

- Prevents reaching inner blocks that contains `if TYPE_CHECKING`

## 1.15.2

- Log a warning instead of crashing when a type guard import fails to resolve
- When resolving type guard imports if the target module does not have source code (such is the case for C-extension
  modules) do nothing instead of crashing

## 1.15.1

- Fix `fully_qualified` should be `typehints_fully_qualified`

## 1.15.0

- Resolve type guard imports before evaluating annotations for objects
- Remove `set_type_checking_flag` flag as this is now done by default
- Fix crash when the `inspect` module returns an invalid python syntax source
- Made formatting function configurable using the option `typehints_formatter`

## 1.14.1

- Fixed `normalize_source_lines()` messing with the indentation of methods with decorators that have parameters starting
  with `def`.
- Handle `ValueError` or `TypeError` being raised when signature of an object cannot be determined
- Fix `KeyError` being thrown when argument is not documented (e.g. `cls` argument for class methods, and `self` for
  methods)

## 1.14.0

- Added `typehints_defaults` config option allowing to automatically annotate parameter defaults.

## 1.13.1

- Fixed `NewType` inserts a reference as first argument instead of a string

## 1.13.0

- Dropped Python 3.6 support
- Python 3.10 support
- Normalize async functions properly
- Allow py310 style annotations (PEP-563)
  • Loading branch information
wiz committed May 6, 2023
1 parent 3b4e0fc commit 988ea56
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 24 deletions.
23 changes: 12 additions & 11 deletions textproc/py-sphinx-autodoc-typehints/Makefile
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
# $NetBSD: Makefile,v 1.7 2022/01/04 20:55:05 wiz Exp $
# $NetBSD: Makefile,v 1.8 2023/05/06 09:28:24 wiz Exp $

DISTNAME= sphinx-autodoc-typehints-1.12.0
PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
PKGREVISION= 1
DISTNAME= sphinx_autodoc_typehints-1.23.0
PKGNAME= ${PYPKGPREFIX}-${DISTNAME:S/_/-/g}
CATEGORIES= textproc python
MASTER_SITES= ${MASTER_SITE_PYPI:=s/sphinx-autodoc-typehints/}

MAINTAINER= minskim@NetBSD.org
HOMEPAGE= https://github.com/agronholm/sphinx-autodoc-typehints
HOMEPAGE= https://github.com/tox-dev/sphinx-autodoc-typehints
COMMENT= Type hints support for the Sphinx autodoc extension
LICENSE= mit

BUILD_DEPENDS+= ${PYPKGPREFIX}-setuptools_scm-[0-9]*:../../devel/py-setuptools_scm
DEPENDS+= ${PYPKGPREFIX}-sphinx>=3.0:../../textproc/py-sphinx
TEST_DEPENDS+= ${PYPKGPREFIX}-sphobjinv>=2.0:../../textproc/py-sphobjinv
TEST_DEPENDS+= ${PYPKGPREFIX}-test>=3.1.0:../../devel/py-test
TEST_DEPENDS+= ${PYPKGPREFIX}-typing-extensions>=3.5:../../devel/py-typing-extensions
TOOL_DEPENDS+= ${PYPKGPREFIX}-hatchling-[0-9]*:../../devel/py-hatchling
TOOL_DEPENDS+= ${PYPKGPREFIX}-hatch-vcs-[0-9]*:../../devel/py-hatch-vcs
DEPENDS+= ${PYPKGPREFIX}-sphinx>=5.3:../../textproc/py-sphinx
TEST_DEPENDS+= ${PYPKGPREFIX}-sphobjinv>=2.3.1:../../textproc/py-sphobjinv
TEST_DEPENDS+= ${PYPKGPREFIX}-test>=7.2.2:../../devel/py-test
TOOL_DEPENDS+= ${PYPKGPREFIX}-nptyping-[0-9]*:../../math/py-nptyping
#TEST_DEPENDS+= ${PYPKGPREFIX}-typing-extensions>=4.5:../../devel/py-typing-extensions

USE_LANGUAGES= # none

Expand All @@ -24,5 +25,5 @@ PYTHON_VERSIONS_INCOMPATIBLE= 27
do-test:
cd ${WRKSRC} && ${MAKE_ENV} ${TEST_ENV} pytest-${PYVERSSUFFIX} tests

.include "../../lang/python/egg.mk"
.include "../../lang/python/wheel.mk"
.include "../../mk/bsd.pkg.mk"
26 changes: 17 additions & 9 deletions textproc/py-sphinx-autodoc-typehints/PLIST
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
@comment $NetBSD: PLIST,v 1.1 2018/05/27 01:59:35 minskim Exp $
${PYSITELIB}/${EGG_INFODIR}/PKG-INFO
${PYSITELIB}/${EGG_INFODIR}/SOURCES.txt
${PYSITELIB}/${EGG_INFODIR}/dependency_links.txt
${PYSITELIB}/${EGG_INFODIR}/requires.txt
${PYSITELIB}/${EGG_INFODIR}/top_level.txt
${PYSITELIB}/sphinx_autodoc_typehints.py
${PYSITELIB}/sphinx_autodoc_typehints.pyc
${PYSITELIB}/sphinx_autodoc_typehints.pyo
@comment $NetBSD: PLIST,v 1.2 2023/05/06 09:28:24 wiz Exp $
${PYSITELIB}/${WHEEL_INFODIR}/INSTALLER
${PYSITELIB}/${WHEEL_INFODIR}/METADATA
${PYSITELIB}/${WHEEL_INFODIR}/RECORD
${PYSITELIB}/${WHEEL_INFODIR}/REQUESTED
${PYSITELIB}/${WHEEL_INFODIR}/WHEEL
${PYSITELIB}/${WHEEL_INFODIR}/direct_url.json
${PYSITELIB}/${WHEEL_INFODIR}/licenses/LICENSE
${PYSITELIB}/sphinx_autodoc_typehints/__init__.py
${PYSITELIB}/sphinx_autodoc_typehints/__init__.pyc
${PYSITELIB}/sphinx_autodoc_typehints/attributes_patch.py
${PYSITELIB}/sphinx_autodoc_typehints/attributes_patch.pyc
${PYSITELIB}/sphinx_autodoc_typehints/patches.py
${PYSITELIB}/sphinx_autodoc_typehints/patches.pyc
${PYSITELIB}/sphinx_autodoc_typehints/py.typed
${PYSITELIB}/sphinx_autodoc_typehints/version.py
${PYSITELIB}/sphinx_autodoc_typehints/version.pyc
8 changes: 4 additions & 4 deletions textproc/py-sphinx-autodoc-typehints/distinfo
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
$NetBSD: distinfo,v 1.6 2021/10/26 11:23:13 nia Exp $
$NetBSD: distinfo,v 1.7 2023/05/06 09:28:24 wiz Exp $

BLAKE2s (sphinx-autodoc-typehints-1.12.0.tar.gz) = 63b7d88608016e5323fbe93f76485d1a36a9541b091e739eaf186276b6af10f9
SHA512 (sphinx-autodoc-typehints-1.12.0.tar.gz) = 92fa340495a48111fa3d600d8c46d83214505ac2a5c71cb1303e846ac439f1e0ff14f8ce8dfd5ffdb6a62a9fa15dde8a5227f946840d9377ad5f7fde25894b75
Size (sphinx-autodoc-typehints-1.12.0.tar.gz) = 19494 bytes
BLAKE2s (sphinx_autodoc_typehints-1.23.0.tar.gz) = 3f2064af732dc83c2d927b68e7593149c0109a32f94b3cba03a79b4582f4549e
SHA512 (sphinx_autodoc_typehints-1.23.0.tar.gz) = 990db1f042913088fddf56cbc9ad5f401f7d886164c348aaf19fd1541fa1566a2d58d1c182e52d839d1dd32606ca3da1191b7062a6ed9c8f04dc6a47efaf5488
Size (sphinx_autodoc_typehints-1.23.0.tar.gz) = 35945 bytes

0 comments on commit 988ea56

Please sign in to comment.