Mkapi
MkDocs plugin for automatic API documentation generation from Python docstrings
Overview
MkAPI is a plugin designed for MkDocs that simplifies the creation of API documentation for Python projects. By automatically extracting and structuring docstrings, MkAPI streamlines the documentation process, making it easier for developers to maintain and share their API documentation. The plugin supports two popular styles of docstrings - Google style and NumPy style, providing flexibility for developers to choose the format that best suits their project.
Features
- Type Annotation Support: Automatically includes type annotations from function definitions in the documentation.
- Object Type Inspection: Determines the types of Python objects for accurate representation in the documentation.
- Docstring Inheritance: Supports inheriting docstring content from parent classes to avoid duplication.
- Automatic Table of Contents Generation: Creates a table of contents for packages, modules, and classes for improved navigation.
- Bidirectional Links: Establishes links between the documentation and the source code for seamless navigation.
Summary
MkAPI is a powerful plugin for MkDocs that aims to enhance the documentation process for Python projects. With features like type annotation support, object type inspection, and automatic table of contents generation, MkAPI simplifies the creation and maintenance of API documentation. By providing flexibility in docstring styles and bidirectional links between documentation and source code, MkAPI offers developers a comprehensive solution for efficient and accessible documentation.
