Skip to main content

Extended sphinx autodoc including automatic autosummaries

Project description

docs

Documentation Status

tests

Travis Requirements Status Coverage

package

PyPI Package latest release Supported versions Supported implementations

Welcome! This sphinx extension provides some useful extensions to the Sphinxs autodoc extension. Those are

  1. It creates a Table of Contents in the style of the autosummary extension with methods, classes, functions and attributes

  2. 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

  3. 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.

Installation

Simply install it via pip:

$ pip install autodocsumm

Or you install it via:

$ python setup.py install

from the source on GitHub.

Requirements

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

Quickstart

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,
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autodocsumm-0.1.11.tar.gz (18.0 kB view details)

Uploaded Source

File details

Details for the file autodocsumm-0.1.11.tar.gz.

File metadata

  • Download URL: autodocsumm-0.1.11.tar.gz
  • Upload date:
  • Size: 18.0 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for autodocsumm-0.1.11.tar.gz
Algorithm Hash digest
SHA256 d4ba2fe3a07d2e13165509c3e275f0e16b11e84c873adccaa1e31502a59c452a
MD5 5212b08eb20632c1cd21830718fcaada
BLAKE2b-256 7c2dd8eb07ca710aa602e97939dcae40463585c61e57fc2f0b128abbdf639de1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page