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.12.tar.gz
(38.6 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_automodapi-0.12-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83bef65c2862fc377c7758efddd9426a6a299bd6e55156389c00ae7216d8e4f4 |
|
MD5 | ddceb85b8e848ca1e87067aea2332cb6 |
|
BLAKE2b-256 | 18030b6ea348c1c95880865c9ad66c8d3f5e9060166b7df35bdb58bf2540ecb9 |