Skip to main content

A plugin for MkDocs to generate API documentation

Project description


PyPI Version Python Version Build Status Coverage Status

MkAPI is a plugin for MkDocs to generate API documentation for your Python project.

MkAPI supports two styles of docstrings: Google and NumPy. See Napoleon documentation for details.


Schemdraw (package tree view & package summary)


Polars (class documentation & link to source code)


Altair (table of contents)



  • Type annotation: If you write your function such as def func(x: int) -> str:, you don't need write type(s) in Parameters, Returns, or Yields section again. You can override the type annotation in the corresponding docstring.
  • Object type inspection: MkAPI plugin creates class, dataclass, function, method, property prefix for each object.
  • Docstring inheritance: Docstring of a subclass can inherit parameters and attributes description from its superclasses.
  • Table of Contents: Table of contents are inserted into the documentation of each package, module, and class.
  • Bidirectional Link: Bidirectional links are created between documentation and source code.


Install the MkAPI plugin using pip:

pip install mkapi


Add the following lines to mkdocs.yml:

  - mkapi


MkAPI provides two modes to generate API documentation: Object mode and Page mode.

Object Mode

To generate the API documentation in a Markdown source, add three colons + object full name. The object can be a function, class, attribute, or module.

::: package.module.object

The Object mode is useful to embed an object documentation in an arbitrary position of a Markdown source. For more details, see Object mode.

Page Mode

Using the Page mode, you can construct a comprehensive API documentation for your project. You can get this powerful feature by just one line in mkdocs.yml:

  - API: $api/package.***

For more details, see Page mode.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkapi-2.1.0.tar.gz (52.9 kB view hashes)

Uploaded Source

Built Distribution

mkapi-2.1.0-py3-none-any.whl (38.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page