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 links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for agj from gravatar.com agj Avatar for AWhetter from gravatar.com AWhetter Avatar for ericholscher from gravatar.com ericholscher

Credits

Author: Eric Holscher

Maintainer: Ashley Whetter

License

MIT License

Requires

Python >=3.10

Classifiers

Report project as malware

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

Uploaded Source

Built Distribution

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

sphinx_autoapi-3.8.1-py3-none-any.whl (36.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_autoapi-3.8.1.tar.gz
  • Upload date:
  • Size: 58.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sphinx_autoapi-3.8.1.tar.gz
Algorithm Hash digest
SHA256 04643fc50485039294ace8b660d0d1b821a1686824a975725a5106e8cf1fb30b
MD5 241dd47bd966cdb5a7dcfb5522fa6461
BLAKE2b-256 095e7b42f3f774aa116741b8031b740c854612ed7dd7d616695e934a2b7fb94f

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autoapi-3.8.1.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.8.1-py3-none-any.whl.

File metadata

  • Download URL: sphinx_autoapi-3.8.1-py3-none-any.whl
  • Upload date:
  • Size: 36.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sphinx_autoapi-3.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9a3bd3ee1ba82d537f1620a3922292d43ee8b9ff9c69bc198965ac4bcd5a6775
MD5 054fea2643376150284159b24eafe33f
BLAKE2b-256 724ee49564ab6f38341921ae855451aed2ba9915f61c43780200d5aebb57ae4d

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autoapi-3.8.1-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.

Release history Release notifications | RSS feed

This release

3.8.1 This release

2 files

3.8.0

2 files

3.7.0

2 files

3.6.1

2 files

3.6.0

2 files

3.5.0

2 files

3.4.0

2 files

3.3.3

2 files

3.3.2

2 files

3.3.1

2 files

3.3.0

2 files

3.2.1

2 files

3.2.0

2 files

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

Pre-release

3.1.0b0

2 files

Pre-release

3.1.0a3

2 files

Pre-release

3.1.0a2

2 files

Pre-release

3.1.0a1

2 files

3.0.0

2 files

Pre-release

3.0.0a4

2 files

2.1.1

2 files

2.1.0

2 files

2.0.1

2 files

2.0.0

2 files

1.9.0

2 files

1.8.4

2 files

1.8.3

2 files

1.8.2

2 files

1.8.1

2 files

1.8.0

2 files

1.7.0

2 files

1.6.0

2 files

1.5.1

2 files

1.5.0

2 files

1.4.0

2 files

1.3.0

2 files

1.2.1

2 files

1.2.0

2 files

1.1.0

2 files

1.0.0

2 files

0.7.1

2 files

0.7.0

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.1

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page