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
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 details)
Built Distribution
File details
Details for the file sphinx-automodapi-0.12.tar.gz.
File metadata
- Download URL: sphinx-automodapi-0.12.tar.gz
- Upload date:
- Size: 38.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a1338bc0a7f5c9bb317ecf7c7abd489c7cff452098205ef5110f733570516ac0 |
|
| MD5 | 7ab064c001a2d58d06d9d1ef85b69dee |
|
| BLAKE2b-256 | d9fd914dba5ecddbf81420facbc9f31ddcc18129ae4e2fc9fe75fe84beb01c6d |
File details
Details for the file sphinx_automodapi-0.12-py2.py3-none-any.whl.
File metadata
- Download URL: sphinx_automodapi-0.12-py2.py3-none-any.whl
- Upload date:
- Size: 71.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 83bef65c2862fc377c7758efddd9426a6a299bd6e55156389c00ae7216d8e4f4 |
|
| MD5 | ddceb85b8e848ca1e87067aea2332cb6 |
|
| BLAKE2b-256 | 18030b6ea348c1c95880865c9ad66c8d3f5e9060166b7df35bdb58bf2540ecb9 |
