Sphinx extension for auto-generating API documentation for entire modules

Navigation

Verified details

These details have been verified by PyPI
Owner
Maintainers
Avatar for bsipocz from gravatar.com bsipocz Avatar for Erik.Tollerud from gravatar.com Erik.Tollerud Avatar for robitaille from gravatar.com robitaille Avatar for saimon from gravatar.com saimon

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (BSD 3-Clause License)
  • Author: The Astropy Developers
  • Requires: Python >=3.8
  • Provides-Extra: rtd, test
Classifiers

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!

Supported by

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