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

Uploaded Source

Built Distribution

sphinx_automodapi-0.18.0-py3-none-any.whl (88.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_automodapi-0.18.0.tar.gz
  • Upload date:
  • Size: 51.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for sphinx_automodapi-0.18.0.tar.gz
Algorithm Hash digest
SHA256 7bf9d9a2cb67a5389c51071cfd86674ca3892ca5d5943f95de4553d6f35dddae
MD5 4fcf30339258adb98c4602a7c139236f
BLAKE2b-256 dc38ffc5c1dc26776f1d037021ebcffdfaca74644ec5e5cf5a7735149c51df90

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_automodapi-0.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 022860385590768f52d4f6e19abb83b2574772d2721fb4050ecdb6e593a1a440
MD5 bda666929ec5398a90d73ff61baf5b5e
BLAKE2b-256 d5965492f177d6bb95c5418315ab1c517283f06895b4066f2837ba215be42c84

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