Extended sphinx autodoc including automatic autosummaries
Welcome! This sphinx extension provides some useful extensions to the Sphinxs autodoc extension. Those are
- It creates a Table of Contents in the style of the autosummary extension with methods, classes, functions and attributes
- As you can include the __init__ method documentation for via the autoclass_content configuration value, we provide the autodata_content configuration value to include the documentation from the __call__ method
- You can exclude the string representation of specific objects. E.g. if you have a large dictionary using the not_document_data configuration value.
See the Documentation on Readthedocs for more details.
Simply install it via pip:
$ pip install autodocsumm
Or you install it via:
$ python setup.py install
from the source on GitHub.
The package only requires Sphinx to be installed. It has been tested for versions higher than 1.3.