Extending your autodoc API docs with a summary
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
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,
}1 maintainer
Metadata
1 maintainer
Release files for autodocsumm 0.1.11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| autodocsumm-0.1.11.tar.gz | 18.0 kB | Without provenance | Details for autodocsumm-0.1.11.tar.gz |
Release files / autodocsumm-0.1.11.tar.gz
| 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 | |
|
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
|
Security for autodocsumm 0.1.11
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
