Skip to main content

Sphinx API documentation generator

Project description

Documentation Travis Build Status Appveyor Build Status PyPI Version Supported Python Versions Formatted with Black

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 godocjson
Javascript Alpha jsdoc
.NET Alpha docfx

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-autoapi

Next, 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.

tox

Code Style

Code is formatted using black.

You can check your formatting using black’s check mode:

tox -e formatting

You 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 install

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.

Files for sphinx-autoapi, version 1.2.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_autoapi-1.2.1-py2.py3-none-any.whl (50.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size sphinx-autoapi-1.2.1.tar.gz (38.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page