Sphinx AutoAPI

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 some manual authoring and uses code imports, AutoAPI finds and generates documentation by parsing source code.

Beginner Guides

New to AutoAPI? Check out the Tutorials. They are a hands-on introduction for beginners.

To the beginner guides

User Guides

The user guides are recipes for key tasks and common problems.

To the user guides

Reference Guide

The reference guide contains a detailed description of the configuration options, directives, and templates included in AutoAPI.

To the reference guide

Contributor Guides

Want to add to the codebase? The contributing guidelines will guide you through the process of improving AutoAPI.

To the contributor guides