CVS log for pkgsrc/textproc/py-sphinx-autodoc-typehints/Makefile

Up to [cvs.NetBSD.org] / pkgsrc / textproc / py-sphinx-autodoc-typehints

Request diff between arbitrary revisions

Keyword substitution: kv
Default branch: MAIN

py-sphinx-autodoc-typehints: updated to 3.2.0

3.2.0

Fixed broken changelog link
Fix issue 481
Don't add :rtype: None
Place rtype after directive

py-sphinx-autodoc-typehints: update to 3.1.0.

Support Sphinx 8.2.0 - drop 3.10 support because Sphinx does

py-sphinx-autodoc-typehints: updated to 3.0.1

3.0.1

Fix roles for types module
Update Ruff to 0.9.1

py-sphinx-autodoc-typehints: py-nptyping not used any longer

ride update

py-sphinx-autodoc-typehints: update to 3.0.0.

What's Changed

    🐛 Replace docutils private API use w/ public by @webknjaz in #507
    Drop support for nptyping by @gaborbernat in #514

py-sphinx-autodoc-typehints: add bug report about test failure

py-sphinx-autodoc-typehints: update to 2.5.0.

Fix the type checker by @gaborbernat in #493
Apply typehints_formatter to signature by @Priyansh121096 in #494

*: clean-up after python38 removal

py-sphinx-autodoc-typehints: update to 2.4.4.

 [pre-commit.ci] pre-commit autoupdate (#484)
 Improve the CI (#485)
 Update README.md
 Fix broken link in README
 Link to API directly

py-sphinx-autodoc-typehints: updated to 2.4.1

2.4.1

Fix placement of return type when there is a doctest

py-sphinx-autodoc-typehints: updated to 2.4.0

2.4.0

Drop 3.9 support
Add 3.13 support
Bump dependencies

py-sphinx-autodoc-typehints: updated to 2.3.0

2.3.0

Add module name rewrite configuration option

py-sphinx-autodoc-typehints: not for Python 3.9

py-sphinx-autodoc-typehints: update to 2.2.3.

Fix mypy errors due to unneeded type ignores by @hoodmane in #469
Fix rendering when docstring starst with a directive by @hoodmane in #468

py-sphinx-autodoc-typehints: update to 2.2.2.

2.2.2

What's Changed

    Fix for Issue #384: typehints_defaults = "braces-after" fails for a multiline :param: entry by @tikuma-lsuhsc in #464

2.2.1

What's Changed

    Fix issue #462 and another alias processing bug by @tikuma-lsuhsc in #463

2.2.0

What's Changed

    Support autodoc_type_aliases configuration by @tikuma-lsuhsc in #459

py-sphinx-autodoc-typehints: update to 2.1.1.

Changes: not documented.

py-sphinx-autodoc-typehints: update to 2.1.0.

Support Sphinx 7.3 and drop 3.8 support by @gaborbernat in #448

py-sphinx-autodoc-typehints: updated to 2.0.1

2.0.1

Extend linter/formatter rules
Fix the CI
Add missing option to readme
Return injection fix

py-sphinx-autodoc-typehints: update to 2.0.0.

Add option to force unions (and options) to be rendered with bars
by @hoodmane in #418 (on by default, hence major version bump)

py-sphinx-autodoc-typehints: updated to 1.25.3

1.25.3

Stop parsing from overwriting Sphinx configuration

py-sphinx-autodoc-typehints: updated to 1.25.2

1.25.2
ENH Make types in signature respect typehints_fully_qualified

1.25.1
FIX Put a slash space between xref and type args

1.25.0
ENH Add a css wrapper to generated types

py-sphinx-autodoc-typehints: update to 1.24.1.

1.24.1

fix: Recursively evaluate guarded code by @Mr-Pepe in #393

1.24.0

Exclude dependabot and pre-commit ci from release notes by @gaborbernat in #369
Drop typed-ast as is no longer maintained/used by @gaborbernat in #373

python/wheel.mk: simplify a lot, and switch to 'installer' for installation

This follows the recommended bootstrap method (flit_core, build, installer).

However, installer installs different files than pip, so update PLISTs
for all packages using wheel.mk and bump their PKGREVISIONs.

*: remove more references to Python 3.7

py-sphinx-autodoc-typehints: update to 1.23.3.

What's Changed

    [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #362
    [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #364
    Fix type guard handling for classes by @gaborbernat in #365

py-sphinx-autodoc-typehints: update to 1.23.2.

1.23.2

What's Changed

    Test against 3.12 beta 2 by @gaborbernat in #360
    Remove dependency on itself from pyproject.toml by @0-wiz-0 in #361

1.23.1

What's Changed

    Fix broken github link in README.md by @thisch in #346
    Bump deps and tools by @gaborbernat in #348
    Add trusted-publish by @gaborbernat in #350
    Add 3.12 support by @gaborbernat in #352
    Bump pypa/gh-action-pypi-publish from 1.8.5 to 1.8.6 by @dependabot in #354
    Use ruff by @gaborbernat in #359

*: restrict py-numpy users to 3.9+ in preparation for update

## 1.22

- 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](https://github.com/tox-dev/sphinx-autodoc-typehints/pull/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)

*: bump PKGREVISION for egg.mk users

They now have a tool dependency on py-setuptools instead of a DEPENDS

py-sphinx-autodoc-typehints: updated to 1.12.0

1.12.0
- Dropped Python 3.5 support
- Added the simplify_optional_unions config option
- Fixed indentation of multiline strings

py-sphinx-autodoc-typehints: updated to 1.11.1

1.11.1
======
* Changed formatting of ``None`` to point to the Python stdlib docs
* Updated special dataclass handling


1.11.0
======
* Dropped support for Sphinx < 3.0
* Added support for alternative parameter names (``arg``, ``argument``, ``parameter``)
* Fixed import path for Signature
* Fixed ``TypeError`` when formatting a parametrized ``typing.IO`` annotat

py-sphinx-autodoc-typehints: update to 1.10.3.

1.10.3
======

* Fixed ``TypeError`` (or wrong rendered class name) when an annotation is a generic class that has
  a ``name`` property


1.10.2
======

* Fixed inner classes missing their parent class name(s) when rendered


1.10.1
======

* Fixed ``KeyError`` when encountering mocked annotations (``autodoc_mock_imports``)


1.10.0
======

* Rewrote the annotation formatting logic (fixes Python 3.5.2 compatibility regressions and an
  ``AttributeError`` regression introduced in v1.9.0)
* Fixed decorator classes not being processed as classes


1.9.0
=====

* Added support for typing_extensions_
* Added the ``typehints_document_rtype`` option (PR by Simon-Martin Schröder)
* Fixed metaclasses as annotations causing ``TypeError``
* Fixed rendering of ``typing.Literal``
* Fixed OSError when generating docs for SQLAlchemy mapped classes
* Fixed unparametrized generic classes being rendered with their type parameters
  (e.g. ``Dict[~KT, ~VT]``)

.. _typing_extensions: https://pypi.org/project/typing-extensions/


1.8.0
=====

* Fixed regression which caused ``TypeError`` or ``OSError`` when trying to set annotations due to
  PR #87
* Fixed unintentional mangling of annotation type names
* Added proper ``:py:data`` targets for ``NoReturn``, ``ClassVar`` and ``Tuple``
* Added support for inline type comments (like ``(int, str) -> None``) (PR by Bernát Gábor)
* Use the native AST parser for type comment support on Python 3.8+


1.7.0
=====

* Dropped support for Python 3.4
* Fixed unwrapped local functions causing errors (PR by Kimiyuki Onaka)
* Fixed ``AttributeError`` when documenting the ``__init__()`` method of a data class
* Added support for type hint comments (PR by Markus Unterwaditzer)
* Added flag for rendering classes with their fully qualified names (PR by Holly Becker)


1.6.0
=====

* Fixed ``TypeError`` when formatting annotations from a class that inherits from a concrete
  generic type (report and tests by bpeake-illuscio)
* Added support for ``typing_extensions.Protocol`` (PR by Ian Good)
* Added support for ``typing.NewType`` (PR by George Leslie-Waksman)


1.5.2
=====

* Emit a warning instead of crashing when an unresolvable forward reference is encountered in type
  annotations


1.5.1
=====

* Fixed escape characters in parameter default values getting lost during signature processing
* Replaced use of the ``config-inited`` event (which inadvertently required Sphinx 1.8) with the
  ``builder-inited`` event


1.5.0
=====

* The setting of the ``typing.TYPECHECKING`` flag is now configurable using the
  ``set_type_checking_flag`` option


1.4.0
=====

* The extension now sets ``typing.TYPECHECKING`` to ``True`` during setup to include conditional
  imports which may be used in type annotations
* Fixed parameters with trailing underscores (PR by Daniel Knell)
* Fixed KeyError with private methods (PR by Benito Palacios Sánchez)
* Fixed deprecation warning about the use of formatargspec (PR by Y. Somda)
* The minimum Sphinx version is now v1.7.0


1.3.1
=====

* Fixed rendering of generic types outside the typing module (thanks to Tim Poterba for the PR)

Forget about Python 3.4

py-sphinx-autodoc-typehints: BUILD_DEPENDS on py-setuptools_scm

textproc/py-sphinx-autodoc-typehints: Import version 1.3.0

This extension allows you to use Python 3 annotations for documenting
acceptable argument types and return value types of functions. This
allows you to use type hints in a very natural fashion.