autodocsumm

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.

Installation

Simply install it via pip:

$ pip install autodocsumm

Or you install it via:

$ python setup.py install

The package only requires Sphinx to be installed. It has been tested for versions higher than 1.3.

In order to activate the autodocsumm extension, you have to list it in your conf.py:

extensions = [
    'sphinx.ext.autodoc',
    ...,
    'autodocsumm',
]

Once this is done, you can use the :autosummary: option for autodoc directives to generate a table at the top, e.g.:

.. automodule:: my.awesome.module
    :autosummary:

Optionally, you can make autodocsumm active by default for all autodoc directives by adding in conf.py:

autodoc_default_options = {
    'autosummary': True,
}

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for autodocsumm 0.1.11
File	Size	Uploaded
autodocsumm-0.1.11.tar.gz	18.0 kB	Sep 20, 2019	Details

Download URL	autodocsumm-0.1.11.tar.gz
Size	18.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`d4ba2fe3a07d2e13165509c3e275f0e16b11e84c873adccaa1e31502a59c452a`
BLAKE2b-256 checksum How to use checksums	`7c2dd8eb07ca710aa602e97939dcae40463585c61e57fc2f0b128abbdf639de1`
Upload date	Sep 20, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1`