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.
Project links
Project details
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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d23a9b0992838645c7cb3099bbbd8ae5490556b7687711ecb339f49863e1eaaa |
|
MD5 | 173152ec7b98d9bab731489ff8553514 |
|
BLAKE2b-256 | 6be5b845d456890c28db4916b2f493c3b1071f191746d88e1d017aac92c82e09 |
Hashes for sphinx_autodoc_typehints-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 256029d43086b4ef93518cc3052f780075b23fbed0e83c48956ff128bda21c56 |
|
MD5 | 8059a17b251073801cb971beda7ab2e2 |
|
BLAKE2b-256 | be0d3f0a3c1148b5fe8b327738b6171ac78e79c0e29d6649581375725df4ebaf |