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

Uploaded Source

Built Distribution

sphinx_automodapi-0.15.0-py3-none-any.whl (80.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx-automodapi-0.15.0.tar.gz
  • Upload date:
  • Size: 47.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for sphinx-automodapi-0.15.0.tar.gz
Algorithm Hash digest
SHA256 fd5871e054df7f3e299dde959afffa849f4d01c6eac274c366b06472afcb06aa
MD5 9f911a3405bf6d8d7a76cceaad1efba3
BLAKE2b-256 6c75f88a689907b603994d7b465ec83453c1db3899e4bf3814d4ffec04b5d7af

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_automodapi-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 06848f261fb127b25d35f27c2c4fddb041e76498733da064504f8077cbd27bec
MD5 4ce7748acfbcbd8f45202af6cd1f075c
BLAKE2b-256 e60de82c7cd935eb569e4522498a1cf9a2057e22f89c6defb80ab22da24bc0f4

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