Skip to main content

Sphinx extension for auto-generating API documentation for entire modules

Project description

Travis Status AppVeyor 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.

Note that packages from the Astropy project should continue to use this extension from the astropy-helpers rather than using this standalone 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.4.tar.gz (29.1 kB view details)

Uploaded Source

Built Distribution

sphinx_automodapi-0.4-py2.py3-none-any.whl (57.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for sphinx-automodapi-0.4.tar.gz
Algorithm Hash digest
SHA256 fbb7718483a862082ac9683133dbb4a82d00c12b3e46228977cb48f2550acadf
MD5 3ab7b671da45483e0b56482ce6a824d2
BLAKE2b-256 69b04b1998cea5db1527bd277cecbc1184eb5b96db9e6057e857a913003f4458

See more details on using hashes here.

Provenance

File details

Details for the file sphinx_automodapi-0.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_automodapi-0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1cb1872f359c216f424578d5991d98dc50be0f31019e9ab21042f823161b8885
MD5 fcd6665710864d6521cfc3b75681c378
BLAKE2b-256 5fb3ac4cfe5f4e981e562bf66a7a115461d5f54d12e330e3ca860c5e46498c79

See more details on using hashes here.

Provenance

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