Skip to main content

Sphinx API documentation generator

Project description

Documentation Github Build Status PyPI Version Supported Python Versions Formatted with Ruff

Sphinx AutoAPI is a Sphinx extension for generating complete API documentation without needing to load, run, or import the project being documented.

In contrast to the traditional Sphinx autodoc, which requires manual authoring and uses code imports, AutoAPI finds and generates documentation by parsing source code.

For more information, see the full documentation.

Getting Started

The following steps will walk through how to add AutoAPI to an existing Sphinx project. For instructions on how to set up a Sphinx project, see Sphinx’s documentation.

Installation

AutoAPI can be installed through pip:

pip install sphinx-autoapi

Next, add and configure AutoAPI in your Sphinx project’s conf.py.

extensions.append('autoapi.extension')

autoapi_dirs = ['path/to/source/files', 'src']

When the documentation is built, AutoAPI will now generate API documentation into an autoapi/ directory and add an entry to the documentation in your top level table of contents!

To configure AutoAPI behaviour further, see the Configuration documentation.

Contributing

Running the tests

Tests are executed through tox.

tox

Code Style

Code is formatted using ruff.

You can check your formatting using ruff format’s check mode:

tox -e format

You can also get ruff to format your changes for you:

ruff format

Release Notes

Release notes are managed through towncrier. When making a pull request you will need to create a news fragment to document your change:

tox -e release_notes -- create --help

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License. See the LICENSE.rst file for details.

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

Uploaded Source

Built Distribution

sphinx_autoapi-3.4.0-py3-none-any.whl (34.1 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_autoapi-3.4.0.tar.gz.

File metadata

  • Download URL: sphinx_autoapi-3.4.0.tar.gz
  • Upload date:
  • Size: 29.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for sphinx_autoapi-3.4.0.tar.gz
Algorithm Hash digest
SHA256 e6d5371f9411bbb9fca358c00a9e57aef3ac94cbfc5df4bab285946462f69e0c
MD5 597186f2cc545dc185e42a517ac65b9c
BLAKE2b-256 4aebcc243583bb1d518ca3b10998c203d919a8ed90affd4831f2b61ad09043d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autoapi-3.4.0.tar.gz:

Publisher: release.yml on readthedocs/sphinx-autoapi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinx_autoapi-3.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_autoapi-3.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4027fef2875a22c5f2a57107c71641d82f6166bf55beb407a47aaf3ef14e7b92
MD5 b2e13450b21e5afc54699cbe4d3cab08
BLAKE2b-256 ded6f2acdc2567337fd5f5dc091a4e58d8a0fb14927b9779fc1e5ecee96d9824

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autoapi-3.4.0-py3-none-any.whl:

Publisher: release.yml on readthedocs/sphinx-autoapi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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