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

Uploaded Source

Built Distribution

sphinx_automodapi-0.7-py2.py3-none-any.whl (62.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for sphinx-automodapi-0.7.tar.gz
Algorithm Hash digest
SHA256 684e623d1cbccfb1211496533142c55c860ed9249892b85d0f0461dd32e4e511
MD5 884171c4b126a648b5be277a119fe575
BLAKE2b-256 84b2462449a4e4c0c60e3c05a674779dd6a16b53ca923c0cd110ccb3073469ff

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_automodapi-0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f3ea501157612879df415ce2eff18583bb3b7651a2e349279eff172f2da3ff23
MD5 8a2d97e446eba985db0dd13d60c57015
BLAKE2b-256 c6be7b24d806568a76d839f4ae0e84edcb71b7e5aa0f958d5bf35ec76acad648

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