Skip to main content

Sphinx extension for auto-generating API documentation for entire modules

Project description

DOI PyPI Docs CI Status Coverage Status

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!

Project details


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.20.0.tar.gz (56.7 kB view details)

Uploaded Source

Built Distribution

sphinx_automodapi-0.20.0-py3-none-any.whl (111.8 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_automodapi-0.20.0.tar.gz.

File metadata

  • Download URL: sphinx_automodapi-0.20.0.tar.gz
  • Upload date:
  • Size: 56.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sphinx_automodapi-0.20.0.tar.gz
Algorithm Hash digest
SHA256 24cc97323f163aeefcefb9bdae9cd0a8ea7b699ece34feab116a2557a44949ac
MD5 fc9a8779beea98be7c0422afc83564be
BLAKE2b-256 7a63f772c362f82edd412233a5bace9bb58c37f49b0b6ca707df7467cedd4c9f

See more details on using hashes here.

File details

Details for the file sphinx_automodapi-0.20.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_automodapi-0.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1d205d4f07c22b1024b270a0340b245b5f819bc4c625ca10db8c06e437cf5d5e
MD5 951b66bff61a32e599cae4ec7a429c2f
BLAKE2b-256 d1b8f3eaf95d46bf9812cd7a2e495de90617d6ef0f65db10cc93075ca089501b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page