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.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63962ea300cd0d89777146a8fae409d3b47a22b4d899e9b0de4745ac29f065ce |
|
MD5 | c06345bcf4bb82413ccf5a6445ef11e9 |
|
BLAKE2b-256 | 1a0b50b536e903e4f7d68a7ca008b335e5126759d2788209abd784c719d5166b |
Hashes for sphinx_autodoc_typehints-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73411483adf094f1babc2501d17c45fc054a1a9002513f0040b1ee265afaf33d |
|
MD5 | 2ed0dbfd1ced2b85b897ba8935410c23 |
|
BLAKE2b-256 | e7a3243634a9bbd4e45a89088ae96e487ebe2c6e3a95428719965cbb391273f0 |