Skip to main content

Sphinx extension for auto-generating API documentation for entire modules

Project description

Azure Status Coverage Status PyPI

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinx-automodapi, version 0.12
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_automodapi-0.12-py2.py3-none-any.whl (71.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size sphinx-automodapi-0.12.tar.gz (38.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page