Sphinx API documentation generator
Project description
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.
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 on Getting Started.
Installation
AutoAPI can be installed through pip:
pip install sphinx-autoapiNext, 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.
toxCode Style
Code is formatted using black.
You can check your formatting using black’s check mode:
tox -e formattingYou can also get black to format your changes for you:
black autoapi/ tests/You can even get black to format changes automatically when you commit using pre-commit:
pip install pre-commit
pre-commit installRelease 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 --helpVersioning
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_autoapi-3.0.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ea207793cba1feff7b2ded0e29364f2995a4d157303a98603cee0ce94cea2688 |
|
| MD5 | 7f24b4a62717b6d6ef3971891d266f5f |
|
| BLAKE2b-256 | f3f8489774c0ebcd96bec1e44e4c23ac741f74895efd5ba1da778b2984e0e3cb |
