Sphinx extension for auto-generating API documentation for entire modules
Project description
About
This is a Sphinx extension to automatically generate API pages for whole modules. It was originally developed for the Astropy project but is now available as a standalone package since it can be used for any other package. The documentation can be found on ReadTheDocs.
Running tests
To run the tests, you can either do:
pytest sphinx_automodapi
or if you have tox installed:
tox -e test
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sphinx-automodapi-0.13.tar.gz
(38.2 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_automodapi-0.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9ebc9c10597f3aab1d93e5a8b1829903eee7c64f5bafb0cf71fd40e5c7d95f0 |
|
MD5 | 3630ddefea9c2054c626637d8a22fb2d |
|
BLAKE2b-256 | 160883a3ee2cd420043538d195f024caac76dc2567a266361d95bb9344ab5594 |