Skip to main content

Extended sphinx autodoc including automatic autosummaries

Project description


Documentation Status


Tests Requirements Status Codecov


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.


Simply install it via pip:

$ pip install autodocsumm

Local development

Use pip on the source on GitHub:

$ pip 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

extensions = [

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

Optionally, you can make autodocsumm active by default for all autodoc directives by adding in

autodoc_default_options = {
    'autosummary': True,


Copyright 2016-2019, Philipp S. Sommer

Copyright 2020-2021, Helmholtz-Zentrum Hereon

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

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.2.10.tar.gz (44.8 kB view hashes)

Uploaded source

Built Distribution

autodocsumm-0.2.10-py3-none-any.whl (14.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page