Introduction

mkdocs plugin to generate API documentation for Python programs

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

Tip

See demo in Showcase section.

Requirements

1. Python 3.10+
2. mkdocs package

Installation

pip install mkdocs-apidescribed-plugin

Configuration

1. Add apidescribed plugin into mkdocs.yml:

   mkdocs.yml

   plugins:
    - search
    - apidescribed 
   

2. Add apidescribed: directive into your documentation followed by a module path:

   index.md

   This is my documentation
   
   ::: apidescribed: somepackage.somemodule
   

Get involved into mkdocs-apidescribed

Submit issues

If you spotted something weird in application behavior or want to propose a feature you can do that at https://github.com/idlesign/mkdocs-apidescribed-plugin/issues

Write code

If you are eager to participate in application development, fork it at https://github.com/idlesign/mkdocs-apidescribed-plugin, write your code, whether it should be a bugfix or a feature implementation, and make a pull request right from the forked project page.

Spread the word

If you have some tips and tricks or any other words in mind that you think might be of interest for the others --- publish it.