NewYour coding agent can read the release notes before it upgrades.Set up the MCP server β
PyPI, #2732 most downloaded on PyPI
Render Python type hints in Sphinx autodoc documentation
Latest stable
3.17.5
Last release 14 days ago
04 Nov 2026
Ships fairly regularly
a new release about every 2 weeks
Nearly every release is documented
notes for 60 of the last 60 stable releases
1 version withdrawn
withdrawn after publishing
11 years old
147 releases Β· first in 2015
Drag across the ruler to compare, or tap a release to open it.
Support alternative parameter names (arg, argument, parameter).
<a name="release-1-11-0-added"></a>
arg, argument, parameter).<a name="release-1-11-0-fixed"></a>
Signature.TypeError when formatting a parametrized typing.IO annotation.__init__() method.<a name="release-1-11-0-breaking-changes"></a>
Support alternative parameter names (arg, argument, parameter).
Fix the import path for Signature.
Fix TypeError when formatting a parametrized typing.IO annotation.
Fix data classes displaying a return type in their __init__() method.
Drop support for Sphinx < 3.0.
Your coding agent can read these notes before it upgrades. Set up the MCP server β
Fix TypeError (or a wrong class name) when an annotation is a generic class that has a name property.
<a name="release-1-10-3-fixed"></a>
TypeError (or a wrong class name) when an annotation is a generic class that has a name property.Fix TypeError (or a wrong class name) when an annotation is a generic class that has a name property.
Fix inner classes missing their parent class names when rendered.
<a name="release-1-10-2-fixed"></a>
Fix inner classes missing their parent class names when rendered.
Fix KeyError with mocked annotations (autodoc_mock_imports).
<a name="release-1-10-1-fixed"></a>
KeyError with mocked annotations (autodoc_mock_imports).Fix KeyError with mocked annotations (autodoc_mock_imports).
Process decorator classes as classes.
<a name="release-1-10-0-added"></a>
<a name="release-1-10-0-fixed"></a>
AttributeError introduced in 1.9.0.Process decorator classes as classes.
Rewrite the annotation formatting logic, fixing Python 3.5.2 compatibility and an AttributeError introduced in 1.9.0.
Add the typehints_document_rtype option.
<a name="release-1-9-0-added"></a>
typing_extensions.typehints_document_rtype option.<a name="release-1-9-0-fixed"></a>
TypeError.typing.Literal.OSError when generating docs for SQLAlchemy mapped classes.Dict[~KT, ~VT].Support typing_extensions.
Add the typehints_document_rtype option.
Fix metaclasses as annotations causing TypeError.
Fix rendering of typing.Literal.
Fix OSError when generating docs for SQLAlchemy mapped classes.
Fix unparametrized generic classes rendering with their type parameters, such as Dict[~KT, ~VT].
Add data targets for NoReturn, ClassVar and Tuple.
<a name="release-1-8-0-added"></a>
:py:data targets for NoReturn, ClassVar and Tuple.(int, str) -> None.<a name="release-1-8-0-fixed"></a>
TypeError or OSError when setting annotations.Add :py:data targets for NoReturn, ClassVar and Tuple.
Support inline type comments such as (int, str) -> None.
Fix a regression causing TypeError or OSError when setting annotations.
Fix unintentional mangling of annotation type names.
Add an option to render classes with their fully qualified names.
<a name="release-1-7-0-added"></a>
<a name="release-1-7-0-fixed"></a>
AttributeError when documenting the __init__() method of a data class.Drop Python 3.4 support.
Support type hint comments.
Add an option to render classes with their fully qualified names.
Fix unwrapped local functions causing errors.
Fix AttributeError when documenting the __init__() method of a data class.
Support typing_extensions.Protocol.
<a name="release-1-6-0-added"></a>
typing_extensions.Protocol.typing.NewType.<a name="release-1-6-0-fixed"></a>
TypeError when formatting annotations from a class that inherits from a concrete generic type.Support typing_extensions.Protocol.
Support typing.NewType.
Fix TypeError when formatting annotations from a class that inherits from a concrete generic type.
Warn instead of crashing on an unresolvable forward reference in type annotations.
<a name="release-1-5-2-fixed"></a>
Warn instead of crashing on an unresolvable forward reference in type annotations.
Keep escape characters in parameter default values during signature processing.
<a name="release-1-5-1-fixed"></a>
<a name="release-1-5-1-changes"></a>
builder-inited event instead of config-inited, which required Sphinx 1.8.Keep escape characters in parameter default values during signature processing.
Use the builder-inited event instead of config-inited, which required Sphinx 1.8.
Add the set_type_checking_flag option to control setting typing.TYPE_CHECKING.
<a name="release-1-5-0-added"></a>
set_type_checking_flag option to control setting typing.TYPE_CHECKING.Add the set_type_checking_flag option to control setting typing.TYPE_CHECKING.
Fix a deprecation warning about the use of formatargspec.
<a name="release-1-4-0-added"></a>
typing.TYPE_CHECKING to True during setup to include conditional imports used in type annotations.<a name="release-1-4-0-fixed"></a>
KeyError with private methods.formatargspec.typing module.<a name="release-1-4-0-breaking-changes"></a>
Set typing.TYPE_CHECKING to True during setup to include conditional imports used in type annotations.
Fix parameters with trailing underscores.
Fix KeyError with private methods.
Fix a deprecation warning about the use of formatargspec.
Fix rendering of generic types outside the typing module.
Require Sphinx 1.7.0 or later.
Drop support for Python 3.5.0 and 3.5.1.
<a name="release-1-3-0-added"></a>
<a name="release-1-3-0-fixed"></a>
Add Python 3.7 support.
Drop support for Python 3.5.0 and 3.5.1.
Fix crash when processing docstrings from nested classes.
Keep :rtype: from joining a paragraph of text.
<a name="release-1-2-5-fixed"></a>
:rtype: from joining a paragraph of text.Keep :rtype: from joining a paragraph of text.
Fix the first parameter being cut from class methods and static methods.
<a name="release-1-2-4-fixed"></a>
<a name="release-1-2-4-removed"></a>
backports.typing, as it was removed from PyPI.Fix the first parameter being cut from class methods and static methods.
Remove support for backports.typing, as it was removed from PyPI.
Stop process_signature() clobbering signatures explicitly overridden in the docstring.
<a name="release-1-2-3-fixed"></a>
### Bug fixes
Stop process_signature() clobbering signatures explicitly overridden in the docstring.
Prefix ,and other roles with, in casepy is not the default domain of the project.
### New Contributors
[@emonty](https://github.com/emonty) made their first contribution in [#19](https://github.com/tox-dev/sphinx-autodoc-typehints/pull/19)
[π PyPI release](https://pypi.org/project/sphinx-autodoc-typehints/1.2.3/)
[π Full Changelog](https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.2.1...1.2.3)
Stop process_signature() clobbering signatures explicitly overridden in the docstring.
Prefix :class:, :mod: and other roles with :py:, in case py is not the default domain of the project.
Fix ValueError when getargspec() encounters a built-in function.
<a name="release-1-2-1-fixed"></a>
ValueError when getargspec() encounters a built-in function.AttributeError when Any is combined with another type in a Union.Fix ValueError when getargspec() encounters a built-in function.
Fix AttributeError when Any is combined with another type in a Union.
Fix compatibility with Python 3.6 and 3.5.3.
<a name="release-1-2-0-fixed"></a>
NameError when processing signatures of wrapped functions with type hints.__init__() method.__init__() to the class docstring.@property methods.Fix compatibility with Python 3.6 and 3.5.3.
Fix NameError when processing signatures of wrapped functions with type hints.
Fix handling of slotted classes with no __init__() method.
Fix a Sphinx warning about parallel reads.
Stop adding the return type of __init__() to the class docstring.
Keep the return type hints of @property methods.
@wheerd made their first contribution in #3
<a name="release-1-1-0-added"></a>
typing.Tuple.Fix placement of :rtype: after a multi-line :param: or a .
<a name="release-1-0-6-fixed"></a>
:rtype: after a multi-line :param: or a :returns:.Fix placement of :rtype: after a multi-line :param: or a :returns:.
Process the signatures of coroutine functions when using sphinxcontrib-asyncio.
<a name="release-1-0-5-added"></a>
Process the signatures of coroutine functions when using sphinxcontrib-asyncio.
Fix compatibility with Sphinx 1.4.
<a name="release-1-0-4-fixed"></a>
Remove self from exception class constructor signatures.
<a name="release-1-0-3-fixed"></a>
self from exception class constructor signatures.process_signature() removing the first argument of a static method.Remove self from exception class constructor signatures.
Stop process_signature() removing the first argument of a static method.
Process exception classes like normal classes.
<a name="release-1-0-2-added"></a>
Process exception classes like normal classes.
Look up forward references with the right globals.
<a name="release-1-0-1-fixed"></a>
Look up forward references with the right globals.
### Features - Initial release. π PyPI release π Full Changelog
One column per quarter.