Extending your autodoc API docs with a summary


Documentation Status


Tests 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 Examples section 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.


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

extensions = [

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

.. automodule:: autodocsumm

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

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.

Indices and tables