Skip to content

build(deps): update sphinx-autodoc-typehints requirement from >=1.8.0 to >=3.15.0 - #264

Open
dependabot[bot] wants to merge 1 commit into
masterfrom
dependabot/pip/sphinx-autodoc-typehints-gte-3.15.0
Open

dependabot[bot] wants to merge 1 commit into
masterfrom
dependabot/pip/sphinx-autodoc-typehints-gte-3.15.0

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Oct 19, 2026

Copy link
Copy Markdown

Updates the requirements on sphinx-autodoc-typehints to permit the latest version.

Release notes

Sourced from sphinx-autodoc-typehints's releases.

3.15.0

  • Allow projects to show selected Annotated metadata in rendered types with typehints_annotated_metadata. #1071
  • Process method signatures of classes defined inside functions when the module exports the class under a name autodoc can import. #1072
  • Let typehints_formatter receive whether a type appears in a parameter, return, attribute or base when typehints_formatter_pass_context is enabled. #1073
  • Reread documents when typehints_formatter changes in an incremental build, so their rendered types update without sphinx-build -E. #1069
  • Stop an unchanged incremental build from reporting html_static_path as changed after the extension adds its stylesheet. #1070
  • Document inherited special methods of a generic subclass without raising Cannot subscript already-subscripted typing.Generic. #1074
  • Show a property setter's type when Annotated metadata raises during comparison with the getter type, instead of failing the build. #1076
  • Keep the description in a hand-written :Returns: field instead of interpreting it as a numpydoc return type. #1077
  • Skip imports under if TYPE_CHECKING and False instead of resolving types the branch never defines. #1078
  • Advertise Sphinx, autodoc and type hints in the PyPI keywords instead of unrelated virtual environment terms, and add classifiers for documentation, OS independence and the package's type annotations. #1068

PyPI release

Full Changelog: tox-dev/sphinx-autodoc-typehints@3.14.0...3.15.0

Changelog

Sourced from sphinx-autodoc-typehints's changelog.

########### Changelog ###########

.. towncrier-draft-entries:: Unreleased

.. towncrier release notes start


3.17.2 (2026-10-17)


  • Link an overridden method to a documented public owner when its defining class is private and absent from the intersphinx inventory. :pr:1090

3.17.1 (2026-10-17)


  • Describe the package as rendering Python type hints in Sphinx autodoc documentation. :pr:1089

3.17.0 (2026-10-17)


  • Add typehints_modernize_annotations to render legacy typing aliases with current Python spelling. :pr:1085
  • Add an "optional" default style that marks parameters callers may omit without printing their default values. :pr:1086
  • Allow a callback to read descriptions from Annotated metadata classes other than Doc. :pr:1088
  • Explain how Sphinx's autodoc_preserve_defaults applies to default values in parameter descriptions. :pr:1087

3.16.0 (2026-10-17)


  • Read Doc descriptions from annotated-doc as well as typing_extensions. :pr:1083
  • Register the value stylesheet through Sphinx's static-directory API, so loading the extension does not change html_static_path. :pr:1079
  • Honor autodoc_use_type_comments = False when reading types from a function's # type: comment. :pr:1080
  • Use the build platform and false constants when choosing a TYPE_CHECKING guard's branch; skip guards whose other conditions cannot be determined without running code. :pr:1081
  • Keep single-word prose in hand-written :Returns: fields, and recognize numpydoc return types containing spaces. :pr:1082
  • Document support for both Sphinx autodoc implementations and cover re-exported types and NamedTuple references in both modes. :pr:1084

3.15.0 (2026-10-16)


  • Allow projects to show selected Annotated metadata in rendered types with typehints_annotated_metadata. :pr:1071
  • Process method signatures of classes defined inside functions when the module exports the class under a name autodoc can import. :pr:1072

... (truncated)

Commits
  • 1cfa94b Release 3.15.0
  • 6ee1be2 ✨ feat(typing): show selected Annotated metadata (#1071)
  • e561d5b 🐛 fix(properties): handle metadata equality errors (#1076)
  • e8122c0 🐛 fix(numpydoc): preserve manual returns fields (#1077)
  • 478b02a 🐛 fix(guards): respect false compound conditions (#1078)
  • 6574843 🐛 fix(generics): document inherited special methods (#1075)
  • 614e90c ✨ feat(formatter): pass rendering context (#1073)
  • 71dec76 🐛 fix(build): keep static path stable (#1070)
  • 6aa6756 ✨ feat(methods): handle local class methods (#1072)
  • 78c3e1d 🔧 build: correct package search keywords (#1068)
  • Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Updates the requirements on [sphinx-autodoc-typehints](https://github.com/tox-dev/sphinx-autodoc-typehints) to permit the latest version.
- [Release notes](https://github.com/tox-dev/sphinx-autodoc-typehints/releases)
- [Changelog](https://github.com/tox-dev/sphinx-autodoc-typehints/blob/main/docs/changelog.rst)
- [Commits](tox-dev/sphinx-autodoc-typehints@1.8.0...3.15.0)

---
updated-dependencies:
- dependency-name: sphinx-autodoc-typehints
  dependency-version: 3.15.0
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot Bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Oct 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file python Pull requests that update Python code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants