Описание тега autodoc
Extension for the Sphinx documentation generator that imports Python modules in order to extract docstrings in a semi-automatic way.
Python Sphinx extension that can import the modules being documented, and pull in documentation from docstrings in a semi-automatic way.
The sphix.ext.autodoc
extension can be used in conjunction with the sphinx.ext.napoleon
extension. This allows use of NumPy and Google style docstrings. The Napoleon prepocessor will initially convert your docstrings to ReStructured text, that afterwards is processed by autodoc
.
Several commonly used directives are provided by autodoc, namely ..automodule::
and ..autoclass:
For examples of use see the sphinx.ext.autodoc documentation.
See also: python-sphinx docstring sphinx-napoleon