Skip to main content

Sphinx extension for auto-generating API documentation for entire modules

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!

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_automodapi-0.22.0-py3-none-any.whl (111.9 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_automodapi-0.22.0.tar.gz.

File metadata

  • Download URL: sphinx_automodapi-0.22.0.tar.gz
  • Upload date:
  • Size: 56.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sphinx_automodapi-0.22.0.tar.gz
Algorithm Hash digest
SHA256 9a6745d606eb948321f0bb7bd4511dc6d8481da8819caa1604d7138910173b38
MD5 018d258317cf2d930ef2a573a6cf3eea
BLAKE2b-256 3f9f16c79a06f4c6772124f03f1d69a0394bc1f52c154202db5d5905cb3579c7

See more details on using hashes here.

File details

Details for the file sphinx_automodapi-0.22.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_automodapi-0.22.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8ecbe8c8ba33a1e3dbe03aea06879062567d611b543da3f33367512d45118b01
MD5 4f02241179b1a6c81344335950323b09
BLAKE2b-256 d3a01a0c44070d2f7e8761ca221d51e1ce8f959b2a0add4cab13de0a677f81bc

See more details on using hashes here.

Supported by

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