Update dependency sphinx-autodoc-typehints to v2 (!47) · Merge requests · Katharineum zu Lübeck / AlekSIS-App-FiBu

Add option to force unions (and options) to be rendered with bars by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/418 (on by default, hence major version bump)

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.3...2.0.0

`v1.25.3`

Compare Source

What's Changed

Stop parsing from overwriting Sphinx configuration by @flying-sheep in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/422

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.2...1.25.3

`v1.25.2`

Compare Source

What's Changed

ENH Make types in signature respect typehints_fully_qualified by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/400

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.1...1.25.2

`v1.25.1`

Compare Source

What's Changed

FIX Put a slash space between xref and type args by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/399

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.0...1.25.1

`v1.25.0`

Compare Source

What's Changed

ENH Add a css wrapper to generated types by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/397

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.24.1...1.25.0

`v1.24.1`

Compare Source

What's Changed

fix: Recursively evaluate guarded code by @Mr-Pepe in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/393

New Contributors

@Mr-Pepe made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/393

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.24.0...1.24.1

`v1.24.0`

What's Changed

Exclude dependabot and pre-commit ci from release notes by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/369
Drop typed-ast as is no longer maintained/used by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/373

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.23.3...1.24.0

`v1.23.3`

Compare Source

What's Changed

[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/362
[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/364
Fix type guard handling for classes by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/365

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.23.2...1.13.2

`v1.23.2`

Compare Source

What's Changed

Test against 3.12 beta 2 by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/360
Remove dependency on itself from pyproject.toml by @0-wiz-0 in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/361

New Contributors

@0-wiz-0 made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/361

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.23.1...1.23.2

`v1.23.1`

Compare Source

What's Changed

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

New Contributors

@thisch made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/346

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.23.0...1.23.1

`v1.23.0`

Compare Source

What's Changed

[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/320
Bump deps and tools by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/321
Fix the CI by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/324
Add pyproject-fmt by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/330
Bump pypa/gh-action-pypi-publish from 1.6.4 to 1.8.1 by @dependabot in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/334
Bump deps and tools by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/336
Bump pypa/gh-action-pypi-publish from 1.8.1 to 1.8.3 by @dependabot in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/337
Bump pypa/gh-action-pypi-publish from 1.8.3 to 1.8.5 by @dependabot in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/341
Handle attrs forward refs by @znicholls in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/345

New Contributors

@znicholls made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/345

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.22...1.23.0

`v1.22`

Compare Source

Allow Sphinx explicitly to write in parallel.
Fixed crash when documenting ParamSpecArgs

`v1.21.8`

Compare Source

What's Changed

[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/313
NFC: Move patches to a separate file by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/314
Fix typing in #314 by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/315
Patch docutils rst parser to add line numbers to more nodes by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/316

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.21.7...1.27.8

`v1.21.7`

Compare Source

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.

`v1.21.6`

Compare Source

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

`v1.21.5`

Compare Source

More robust determination of rtype location / fix issue 302

`v1.21.4`

Compare Source

Improvements to the location of the return type

`v1.21.3`

Compare Source

Use format_annotation to render class attribute type annotations

`v1.21.2`

Compare Source

Fix overloads support

`v1.21.1`

Compare Source

Fix spacing between :rtype: and directives

`v1.21.0`

Compare Source

What's Changed

Put Literal args in code blocks by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/288
Handle collections.abc.Callable as well as typing.Callable by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/289
Remove redundant return type for attributes by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/287
Put rtype before examples or usage section by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/290
If module is _io, use io instead by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/291
Handle types from types module by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/292

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.20.2...1.21.0

`v1.20.2`

Compare Source

Fix Optional role to be data.

`v1.20.1`

Compare Source

Fixed default options not displaying for parameters without type hints.

`v1.20.0`

Compare Source

What's Changed

[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/268
Bump pypa/gh-action-pypi-publish from 1.5.1 to 1.5.2 by @dependabot in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/270
Bump pypa/gh-action-pypi-publish from 1.5.2 to 1.6.1 by @dependabot in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/271
Bump pypa/gh-action-pypi-publish from 1.6.1 to 1.6.4 by @dependabot in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/273
Added options to retain original typehints in signatures by @BhavyeMathur in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/278

New Contributors

@BhavyeMathur made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/278

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.19.5...1.20.0

`v1.19.5`

Compare Source

What's Changed

[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/262
[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/264
[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/265
Add link to pyproject-api docs as example of this extension by @ketozhang in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/267

New Contributors

@ketozhang made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/267

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.19.4...1.19.5

`v1.19.4`

Compare Source

What's Changed

Fix IndexError for line and keyword split by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/261

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.19.3...1.19.4

`v1.19.3`

Compare Source

What's Changed

[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/251
[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/252
Add support for paramspec by @Numerlor in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/255
allow starred args and kwargs in docstring params by @Numerlor in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/254
Fix the CI by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/258

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.19.2...1.19.3

`v1.19.2`

Compare Source

Fix incorrect domain used for collections.abc.Callable.

`v1.19.1`

Compare Source

Fix bug for recursive type alias.

`v1.19.0`

Compare Source

Support for CPython 3.11, no longer adds Optional when the argument is default per recommendation from PEP-484.

`v1.18.3`

Compare Source

Support and require nptyping>=2.1.2

`v1.18.2`

Compare Source

Support and require nptyping>=2.1.1

`v1.18.1`

Compare Source

Fix mocked module import not working when used as guarded import

`v1.18.0`

Compare Source

Support and require nptyping>=2
Handle UnionType

`v1.17.1`

Compare Source

Mark it as requiring nptyping<2

`v1.17.0`

Compare Source

Add typehints_use_rtype option
Handles TypeError when getting source code via inspect

`v1.16.0`

Compare Source

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)

`v1.15.3`

Compare Source

Prevents reaching inner blocks that contains if TYPE_CHECKING

`v1.15.2`

Compare Source

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

`v1.15.1`

Compare Source

Fix fully_qualified should be typehints_fully_qualified

`v1.15.0`

Compare Source

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

`v1.14.1`

Compare Source

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)

`v1.14.0`

Compare Source

Added typehints_defaults config option allowing to automatically annotate parameter defaults.

`v1.13.1`

Compare Source

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

`v1.13.0`

Compare Source

Dropped Python 3.6 support
Python 3.10 support
Normalize async functions properly
Allow py310 style annotations (PEP-563)

`v1.12.0`

Compare Source

Dropped Python 3.5 support
Added the simplify_optional_unions config option (MR by tillhainbach)
Fixed indentation of multiline strings (MR by Yuxin Wu)

`v1.11.1`

Compare Source

Changed formatting of None to point to the Python stdlib docs (MR by Dominic Davis-Foster)
Updated special dataclass handling (MR by Lihu Ben-Ezri-Ravin)

Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this MR and you won't be reminded about this update again.

If you want to rebase/retry this MR, click this checkbox.

This MR has been generated by Renovate Bot.

Edited Nov 14, 2024 by Tine Wittler

Update dependency sphinx-autodoc-typehints to v2

Release Notes

What's Changed

New Contributors

What's Changed

What's Changed

What's Changed

What's Changed

What's Changed

What's Changed

What's Changed

New Contributors

What's Changed

What's Changed

New Contributors

What's Changed

What's Changed

What's Changed

What's Changed

What's Changed

What's Changed

New Contributors

What's Changed

What's Changed

What's Changed

New Contributors

What's Changed

New Contributors

What's Changed

New Contributors

What's Changed

What's Changed

What's Changed

New Contributors

What's Changed

New Contributors

What's Changed

What's Changed

Configuration

Merge request reports