mkdocs-autoapi#

mkdocs-autoapi is a plugin for MkDocs that generates API documentation from your project's source code. The plugin leverages the functionality provided by mkdocstrings and locates all Python modules in your project to create a set of reference pages.

Installation#

Requirements#

mkdocs-autoapi requires the following:

  • Python version 3.6 or higher
  • MkDocs version 1.4.0 or higher
  • mkdocstrings version 0.19.0 or higher

In addition, you must install an mkdocstrings handler for your project's programming language.

Note

Currently, Python and VBA handlers are supported. Support for additional programming languages (e.g., C, shell) is planned for future releases. See Installation via pip for more details on how to install handlers along with mkdocs-autoapi.

Installation via pip#

To install mkdocs-autoapi with pip:

pip install mkdocs-autoapi

Extras are provided to support installation of mkdocstrings handlers:

pip install mkdocs-autoapi[python] # new Python handler
pip install mkdocs-autoapi[python-legacy] # legacy Python handler
pip install mkdocs-autoapi[vba] # VBA handler

Basic Usage#

To get started using mkdocs-autoapi, add the following to mkdocs.yml:


nav:
  - ... other navigation configuration ...
  - API Reference: autoapi/
  - ... other navigation configuration ...

plugins:
  - ... other plugin configuration ...
  - mkdocs-autoapi
  - mkdocstrings

For details on configuration and examples, see the Usage section.