autodocsumm · Python Simple Repository Browser

Project Links

Meta

Author: Philipp S. Sommer

Requires Python: >=3.7

Classifiers

Development Status

5 - Production/Stable

Intended Audience

Developers

Topic

Documentation

License

OSI Approved :: Apache Software License

Framework

Sphinx
Sphinx :: Extension

Programming Language

Python :: 3
Python :: 3 :: Only
Python :: 3.7
Python :: 3.8
Python :: 3.9
Python :: 3.10
Python :: 3.11
Python :: 3.12

Operating System

OS Independent

docs
tests
package

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.

Installation

Simply install it via pip:

$ pip install autodocsumm

Local development

Use pip on the source on GitHub:

$ pip install .

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

Disclaimer

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

http://www.apache.org/licenses/LICENSE-2.0

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.