New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update dependency sphinx-autodoc-typehints to v3 #52

Open

renovate wants to merge 1 commit into main from renovate/sphinx-autodoc-typehints-3.x

Contributor

renovate bot commented Jan 4, 2025 •

edited

Loading

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
sphinx-autodoc-typehints (changelog)	`==1.11.1` -> `==3.0.1`

Release Notes

tox-dev/sphinx-autodoc-typehints (sphinx-autodoc-typehints)

`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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@2.4.4...2.5.0

`v2.4.4`: Fix broken link in README

Full Changelog: tox-dev/sphinx-autodoc-typehints@2.4.3...2.4.4

`v2.4.3`

Full Changelog: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@2.4.0...2.4.1

`v2.4.0`

Drop 3.9 support
Add 3.13 support
Bump dependencies

Full Changelog: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@2.1.1...2.2.0

`v2.1.1`

Full Changelog: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@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: tox-dev/sphinx-autodoc-typehints@1.23.3...1.24.0

`v1.23.3`

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: tox-dev/sphinx-autodoc-typehints@1.23.2...1.13.2

`v1.23.2`

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: tox-dev/sphinx-autodoc-typehints@1.23.1...1.23.2

`v1.23.1`

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: tox-dev/sphinx-autodoc-typehints@1.23.0...1.23.1

`v1.23.0`: Handle attrs forward refs

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: tox-dev/sphinx-autodoc-typehints@1.22...1.23.0

`v1.22`

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

`v1.21.8`

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: tox-dev/sphinx-autodoc-typehints@1.21.7...1.27.8

`v1.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.

`v1.21.6`

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

`v1.21.5`

More robust determination of rtype location / fix issue 302

`v1.21.4`

Improvements to the location of the return type

`v1.21.3`

Use format_annotation to render class attribute type annotations

`v1.21.2`

Fix overloads support

`v1.21.1`

Fix spacing between :rtype: and directives

`v1.21.0`

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: tox-dev/sphinx-autodoc-typehints@1.20.2...1.21.0

`v1.20.2`

Fix Optional role to be data.

`v1.20.1`

Fixed default options not displaying for parameters without type hints.

`v1.20.0`

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: tox-dev/sphinx-autodoc-typehints@1.19.5...1.20.0

`v1.19.5`

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: tox-dev/sphinx-autodoc-typehints@1.19.4...1.19.5

`v1.19.4`

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: tox-dev/sphinx-autodoc-typehints@1.19.3...1.19.4

`v1.19.3`

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: tox-dev/sphinx-autodoc-typehints@1.19.2...1.19.3

`v1.19.2`

What's Changed

[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/249
only convert role for pydata annotations if module is typing by @Numerlor in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/250

New Contributors

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

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.19.1...1.19.2

`v1.19.1`

What's Changed

Add support for recursive type hints by @hmc-cs-mdrissi in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/248

New Contributors

@hmc-cs-mdrissi made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/248

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.19.0...1.19.1

`v1.19.0`: Support Python 3.11

What's Changed

Bump actions/download-artifact from 2 to 3 by @dependabot in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/240
Bump actions/checkout from 2 to 3 by @dependabot in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/241
Bump actions/setup-python from 2 to 4 by @dependabot in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/242
Bump actions/upload-artifact from 2 to 3 by @dependabot in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/243
[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/236
[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/244
[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/245
[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/246
Check 3.11 support by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/247

New Contributors

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

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.18.3...1.19.0

`v1.18.3`

What's Changed

Fix for new nptyping by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/235

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.18.2...1.18.3

`v1.18.2`

What's Changed

[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/230
Support and require nptyping 2.1.1 by @gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/232

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.18.1...1.18.2

`v1.18.1`

`v1.18.0`

`v1.17.1`

`v1.17.0`: typehints_use_rtype support and handle TypeError

`v1.16.0`

`v1.15.3`

`v1.15.2`

`v1.15.1`

`v1.15.0`

`v1.14.1`

`v1.14.0`: Added document_defaults config option

`v1.13.1`: Fix NewType is inserting a reference as first argument

`v1.13.0`: Python 3.10 support and PEP-563, drop 3.6

`v1.12.0`

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

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

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

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

If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.


          Update dependency sphinx-autodoc-typehints to v3

9d2d02c

renovate bot force-pushed the renovate/sphinx-autodoc-typehints-3.x branch from 4ccaeb7 to 9d2d02c Compare

January 17, 2025 03:53

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet