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!
4 maintainers
Metadata
4 maintainers
Release files for sphinx-automodapi 0.22.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_automodapi-0.22.1.tar.gz | 59.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_automodapi-0.22.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 170.9 kB
Release files / sphinx_automodapi-0.22.1.tar.gz
| Download URL | sphinx_automodapi-0.22.1.tar.gz |
|---|---|
| Size | 59.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
48fb115a7189eff121b2f77027d2d8e59fdbde2f0d1ef3c9adf6c57c3bb86131
|
|
BLAKE2b-256 checksum How to use checksums |
0f2e5a8c4a05ac950bccffd5de70613a3fb3d7bf70b3de6b349dcfe5b8d6b541
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / sphinx_automodapi-0.22.1-py3-none-any.whl
| Download URL | sphinx_automodapi-0.22.1-py3-none-any.whl |
|---|---|
| Size | 111.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a2fca6afa41b23d57171a5f9f9e1f42fffbba941e2a2f96279d5d8a6e5adc973
|
|
BLAKE2b-256 checksum How to use checksums |
e5c2c60c70158dcbef39f2305fda51a203bb6b1d178a4c8180a562da4a118fbf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
