Type hints (PEP 484) support for the Sphinx autodoc extension
Project description
This extension allows you to use Python 3 annotations for documenting acceptable argument types and return value types of functions. This allows you to use type hints in a very natural fashion, allowing you to migrate from this:
def format_unit(value, unit):
"""
Formats the given value as a human readable string using the given units.
:param float|int value: a numeric value
:param str unit: the unit for the value (kg, m, etc.)
:rtype: str
"""
return '{} {}'.format(value, unit)to this:
from typing import Union
def format_unit(value: Union[float, int], unit: str) -> str:
"""
Formats the given value as a human readable string using the given units.
:param value: a numeric value
:param unit: the unit for the value (kg, m, etc.)
"""
return '{} {}'.format(value, unit)Installation and setup
First, use pip to download and install the extension:
$ pip install sphinx-autodoc-typehints
Then, add the extension to your conf.py:
extensions = [
'sphinx.ext.autodoc',
'sphinx_autodoc_typehints'
]How it works
The extension listens to the autodoc-process-signature and autodoc-process-docstring Sphinx events. In the former, it strips the annotations from the function signature. In the latter, it injects the appropriate :type argname: and :rtype: directives into the docstring.
Only arguments that have an existing :param: directive in the docstring get their respective :type: directives added. The :rtype: directive is added if and only if no existing :rtype: is found.
This extension does not currently have any configuration options.
Compatibility with sphinx.ext.napoleon
To use sphinx.ext.napoleon with sphinx-autodoc-typehints, make sure you load sphinx.ext.napoleon first, before sphinx-autodoc-typehints. See Issue 15 on the issue tracker for more information.
Project links
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx-autodoc-typehints-1.2.4.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 87a2dba57c0b9032ff3b86d06106a5812097b4aa031767659a3aa12800351f9b |
|
| MD5 | 272825d63ed709548c707ed2f6ed8897 |
|
| BLAKE2b-256 | e8cf7d4588aad2ef68312cda832f37c2de2c24693f131dbd31b8153520506e90 |
Hashes for sphinx_autodoc_typehints-1.2.4-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e2827b4716b4516fb4f2ad38a492a948f67a7670727bc3e8165e72b475db2b47 |
|
| MD5 | 4a18bb87c5e6dddbfd8ee6872f832100 |
|
| BLAKE2b-256 | a72751509ba63494f03deb14aa69452673d97651cbbd7aceedb70513c9185953 |
