Update dependency sphinx-autodoc-typehints to v3
This MR contains the following updates:
Package | Type | Update | Change |
---|---|---|---|
sphinx-autodoc-typehints (changelog) | dev-dependencies | major |
^1.23 -> ^3.0.0
|
Release Notes
tox-dev/sphinx-autodoc-typehints (sphinx-autodoc-typehints)
v3.2.0
What's Changed
- Fixed broken changelog link by @agronholm in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/530
- Fix issue #481 by @nineteendo in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/533
- Don't add :rtype: None by @grayjk in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/538
- Place rtype after directive by @grayjk in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/537
New Contributors
- @agronholm made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/530
- @nineteendo made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/533
- @grayjk made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/538
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/3.1.0...3.2.0
v3.1.0
What's Changed
- Support Sphinx 8.2.0 - drop 3.10 support because Sphinx does by @b-kamphorst in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/525
New Contributors
- @b-kamphorst made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/525
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/3.0.1...3.1.0
v3.0.1
What's Changed
- Fix roles for
types
module by @flying-sheep in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/516 - Update Ruff to 0.9.1 by @flying-sheep in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/517
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/3.0.0...3.0.1
v3.0.0
What's Changed
-
Replace docutils private API use w/ public by @webknjaz in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/507 - Drop support for nptyping by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/514
New Contributors
- @webknjaz made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/507
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.5.0...3.0.0
v2.5.0
What's Changed
- Fix the type checker by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/493
- Apply typehints_formatter to signature by @Priyansh121096 in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/494
New Contributors
- @Priyansh121096 made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/494
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.4.4...2.5.0
v2.4.4
: Fix broken link in README
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.4.3...2.4.4
v2.4.3
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.4.2...2.4.3
v2.4.2
What's Changed
- Improve the CI by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/485
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.4.1...2.4.2
v2.4.1
What's Changed
- Fix placement of return type when there is a doctest by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/482
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.4.0...2.4.1
v2.4.0
- Drop 3.9 support
- Add 3.13 support
- Bump dependencies
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.3.0...2.4.0
v2.3.0
What's Changed
- Add module name rewrite configuration option by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/474
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.2.3...2.3.0
v2.2.3
What's Changed
- Fix mypy errors due to unneeded type ignores by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/469
- Fix rendering when docstring starst with a directive by @hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/468
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.2.2...2.2.3
v2.2.2
What's Changed
- Fix for Issue #384: typehints_defaults = "braces-after" fails for a multiline
:param:
entry by @tikuma-lsuhsc in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/464
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.2.1...2.2.2
v2.2.1
What's Changed
- Fix issue #462 and another alias processing bug by @tikuma-lsuhsc in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/463
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.2.0...2.2.1
v2.2.0
What's Changed
- Support autodoc_type_aliases configuration by @tikuma-lsuhsc in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/459
New Contributors
- @tikuma-lsuhsc made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/459
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.1.1...2.2.0
v2.1.1
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.1.0...2.1.1
v2.1.0
What's Changed
- Support Sphinx 7.3 and drop 3.8 support by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/448
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.0.1...2.1.0
v2.0.1
What's Changed
- Extend linter/formatter rules by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/427
- Fix the CI by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/434
- Add missing option to readme by @caffeinepills in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/446
- Return injection fix by @caffeinepills in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/445
New Contributors
- @caffeinepills made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/446
Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.0.0...2.0.1
v2.0.0
What's Changed
- 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
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
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
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
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
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
Configuration
-
If you want to rebase/retry this MR, check this box
This MR has been generated by Renovate Bot.
Merge request reports
Activity
Artifact update problemRenovate failed to update an artifact related to this branch. You probably do not want to merge this MR as-is.
Renovate will retry this branch, including artifacts, only when one of the following happens:- any of the package files in this branch needs updating, or
- the branch becomes conflicted, or
- you check the rebase/retry checkbox if found above, or
- you rename this MR's title to start with "rebase!" to trigger it manually
The artifact failure details are included below:
File name: poetry.lock
Creating virtualenv documento-client-3TXHrKOA-py3.10 in /home/ubuntu/.cache/pypoetry/virtualenvs RuntimeError The lock file is not compatible with the current version of Poetry. Upgrade Poetry to be able to read the lock file or, alternatively, regenerate the lock file with the `poetry lock` command. at /usr/local/poetry/1.1.11/venv/lib/python3.10/site-packages/poetry/packages/locker.py:482 in _get_lock_data 478│ "Upgrade Poetry to ensure the lock file is read properly or, alternatively, " 479│ "regenerate the lock file with the `poetry lock` command." 480│ ) 481│ elif not lock_version_allowed: → 482│ raise RuntimeError( 483│ "The lock file is not compatible with the current version of Poetry.\n" 484│ "Upgrade Poetry to be able to read the lock file or, alternatively, " 485│ "regenerate the lock file with the `poetry lock` command." 486│ )
mentioned in issue #18
added 1 commit
- 9af2bfa4 - Update dependency sphinx-autodoc-typehints to v3
added 1 commit
- d38f149b - Update dependency sphinx-autodoc-typehints to v3
Artifact update problemRenovate failed to update an artifact related to this branch. You probably do not want to merge this MR as-is.
Renovate will retry this branch, including artifacts, only when one of the following happens:- any of the package files in this branch needs updating, or
- the branch becomes conflicted, or
- you click the rebase/retry checkbox if found above, or
- you rename this MR's title to start with "rebase!" to trigger it manually
The artifact failure details are included below:
File name: poetry.lock
Updating dependencies Resolving dependencies... The current project's Python requirement (>=3.9,<4.0) is not compatible with some of the required packages Python requirement: - sphinx-autodoc-typehints requires Python >=3.10, so it will not be satisfied for Python >=3.9,<3.10 - sphinx-autodoc-typehints requires Python >=3.10, so it will not be satisfied for Python >=3.9,<3.10 - sphinx-autodoc-typehints requires Python >=3.11, so it will not be satisfied for Python >=3.9,<3.11 Because no versions of sphinx-autodoc-typehints match >3.0.0,<3.0.1 || >3.0.1,<3.1.0 || >3.1.0,<4.0.0 and sphinx-autodoc-typehints (3.0.0) requires Python >=3.10, sphinx-autodoc-typehints is forbidden. And because sphinx-autodoc-typehints (3.0.1) requires Python >=3.10, sphinx-autodoc-typehints is forbidden. So, because sphinx-autodoc-typehints (3.1.0) requires Python >=3.11 and documento-client depends on sphinx-autodoc-typehints (^3.0.0), version solving failed. • Check your dependencies Python requirement: The Python requirement can be specified via the `python` or `markers` properties For sphinx-autodoc-typehints, a possible solution would be to set the `python` property to ">=3.10,<4.0" For sphinx-autodoc-typehints, a possible solution would be to set the `python` property to ">=3.10,<4.0" For sphinx-autodoc-typehints, a possible solution would be to set the `python` property to ">=3.11,<4.0" https://python-poetry.org/docs/dependency-specification/#python-restricted-dependencies, https://python-poetry.org/docs/dependency-specification/#using-environment-markers