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

Uploaded Source

Built Distribution

sphinx_automodapi-0.6-py2.py3-none-any.whl (62.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for sphinx-automodapi-0.6.tar.gz
Algorithm Hash digest
SHA256 81449bdb5d048c5ec4e526dc72fd3535442910c5f6efc0c8a657082357e4f254
MD5 a278c6b802faeb803845691077324649
BLAKE2b-256 9f99978546ba94dcc97b1bc396df0e460b9a1389bfebe731a0d25fa08396fde5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_automodapi-0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 954467758576b1d82638d297d92d33f2abe8289f1e293c3be34c07da57aa4c32
MD5 a72863495412b094aa54c33444d20f82
BLAKE2b-256 af49ff843c48659b0b628270f07e060476846986b0188000d6dd9577ff1cc7a2

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