mkdocs-apidescribed-plugin

May 15, 2025 ยท View on GitHub

https://github.com/idlesign/mkdocs-apidescribed-plugin

PyPI - Version License Coverage Docs

Description

mkdocs plugin to generate API documentation for Python programs

  • Made to autodocument Python code
  • Plays well with Material for MkDocs
  • Configurable
  • Easy to use

Just add ::: apidescribed: directive into your documentation followed by a module path:

This is my documentation

::: apidescribed: somepackage.somemodule

Documentation

https://mkdocs-apidescribed-plugin.readthedocs.io/