Sphinx AutoAPI 2
NOTE: This is a fork of the original sphinx-autoapi, which intended to make it compatible with MyST-Parser. Hopefully, the changes will eventually be merged upstream. The goals are:
Add a set of templates, for use with MyST-Parser
Make it possible to write files with a specific extension, based on a file regex; we want users to be able to gradually migrate existing codebases to MyST-Parser, so being able to specify only certain files will be very helpful.
Sphinx AutoAPI provides “autodoc” style documentation for multiple programming languages without needing to load, run, or import the project being documented.
In contrast to the traditional Sphinx autodoc, which is Python-only and uses code imports, AutoAPI finds and generates documentation by parsing source code.
Language Support
Language |
Status |
Parser |
|---|---|---|
Python |
Stable |
Custom using astroid |
Go |
Alpha |
|
Javascript |
Alpha |
|
.NET |
Alpha |
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. Other languages may require further configuration:
extensions.append('autoapi.extension')
autoapi_type = 'python'
autoapi_dirs = ['path/to/source/files', 'src']Where autoapi_type can be one of any of the supported languages:
Language |
autoapi_type |
|---|---|
Python |
'python' |
Go |
'go' |
Javascript |
'javascript' |
.NET |
'dotnet' |
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 installVersioning
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.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-autoapi2 2.0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx-autoapi2-2.0.1.1.tar.gz | 92.2 kB | Without provenance | Details for sphinx-autoapi2-2.0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_autoapi2-2.0.1.1-py3-none-any.whl | Python 3 | none | any | Details for sphinx_autoapi2-2.0.1.1-py3-none-any.whl |
Total release size: 152.2 kB
Release files / sphinx-autoapi2-2.0.1.1.tar.gz
| Download URL | sphinx-autoapi2-2.0.1.1.tar.gz |
|---|---|
| Size | 92.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b93d0f933d39381523faf7e300ae0597eb23f95b4058adffc0274c47081a7f97
|
|
BLAKE2b-256 checksum How to use checksums |
807758c223840fb16654b60398dc4b1d72c5e01a9d92a15e57c90fa99c8939a8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.28.1
|
Release files / sphinx_autoapi2-2.0.1.1-py3-none-any.whl
| Download URL | sphinx_autoapi2-2.0.1.1-py3-none-any.whl |
|---|---|
| Size | 59.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f1a6d3eeaad6ca4cfc376bd3083a184f217096228c20607e5123656ea4e1778c
|
|
BLAKE2b-256 checksum How to use checksums |
c32f495f87cae5ab28a19edf67e7b8d8ae64908dbaacb028085ba96f17f5ccc3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.28.1
|
Security for sphinx-autoapi2 2.0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
