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
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.3.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bc6d1f09223afe7edbbb1bd28a9b8d8eb2e1088f0b22582b119a68ae71ccd3d6 |
|
| MD5 | 9dc587794145c51279b75fb73681b32c |
|
| BLAKE2b-256 | 8eab8dcdfc9240bb05eca31e5fd6643a74891b856717a0e3e1b45ac305be2cee |
Hashes for sphinx_autodoc_typehints-1.0.3-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4958847a851bf2c3c3b839f3362085c0deb537ffd92cdb860a0c709c0c5f83ce |
|
| MD5 | ab016a02473cac79b48da2ed81fa0118 |
|
| BLAKE2b-256 | 9042815382c0bae118bc38ee3fb36c390d812dd5178a2c4b9a6453e0f9facaea |
