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
Development status
Due to the limitations of FOSS development model, the Astropy Project does not have enough bandwidth to add new features or fixes to this package beyond what is necessary for the project itself. Therefore, we apologize for any inconvenience caused by unresolved open issues and unmerged stale pull requests. If you have any questions or concerns, please contact the project via https://www.astropy.org/help . Thank you for your interest in this package!
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
Built Distribution
File details
Details for the file sphinx-automodapi-0.14.1.tar.gz.
File metadata
- Download URL: sphinx-automodapi-0.14.1.tar.gz
- Upload date:
- Size: 45.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a2f9c0f9e2901875e6db75df6c01412875eb15f25e7db1206e1b69fedf75bbc9 |
|
| MD5 | 045e34fe7f65503e1a499f13afedf277 |
|
| BLAKE2b-256 | c10154ca47788114e0ad411a65138af30e72e1104da2d719902b5303482d024e |
File details
Details for the file sphinx_automodapi-0.14.1-py3-none-any.whl.
File metadata
- Download URL: sphinx_automodapi-0.14.1-py3-none-any.whl
- Upload date:
- Size: 77.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4238e131d7abc47226449661bb3cfa2bb1b5b190184ffa69d9b924b984a22753 |
|
| MD5 | 558f1e29c48a96b387b873545e7b43fc |
|
| BLAKE2b-256 | 30da25d3dd4e5719c442c1920901129b445a28d5583022dabe7de39d69f6202c |
