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

Uploaded Source

Built Distribution

sphinx_automodapi-0.17.0-py3-none-any.whl (85.1 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-automodapi-0.17.0.tar.gz.

File metadata

  • Download URL: sphinx-automodapi-0.17.0.tar.gz
  • Upload date:
  • Size: 49.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for sphinx-automodapi-0.17.0.tar.gz
Algorithm Hash digest
SHA256 7ccdadad57add4aa9149d9f2bb5cf28c8f8b590280b4735b1156ea8355c423a1
MD5 54c693447d26bae9532d77a501d1637b
BLAKE2b-256 4e97396a177acf95aaf39908a4a4ec6d627b7e2092c5a07efa11ac8452037d33

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_automodapi-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4d029cb79eef29413e94ab01bb0177ebd2d5ba86e9789b73575afe9c06ae1501
MD5 dca6036c0bf508b5320e5972f8121545
BLAKE2b-256 02711721d7e49533ab5d675832bb1607c1d8b2a3f6e4454c6c61adba68631a1d

See more details on using hashes here.

Supported by

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