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.6.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 883f4ad56ffecfe4531b69e5a565656e2508b1783fc30a60c8034e602fe2badb |
|
| MD5 | 14b3e7adcee190e53ad8f34041d3a12d |
|
| BLAKE2b-256 | 23d3fd55ea6f20acc5f767a73f35f4c0b99f9de46286471c3c7136f7b12f2d64 |
Hashes for sphinx_autodoc_typehints-1.0.6-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2dfba9e466a789620814183a4857c0fa7bb98ab2a687d6420d2b7e1811d66ff6 |
|
| MD5 | f4fef31e6d239402283fa5ab0e9b5242 |
|
| BLAKE2b-256 | 30b1e40324ca6e8be0637d3a0dcc83570aa2c62da96cd36d529c6dcc5a33f71e |
