MkDoxy
MkDoxy plugin for MkDocs generates API documentation based on Doxygen comments and code snippets in your markdown files.
Warning
Extension is in development, and a few features are not working properly.
More information in Discussions and Issues pages.
Feature List - Installation - Quick start
Feature List
Installation
Install the plugin using pip from PyPI:
pip install mkdoxy
Development version with all dependencies:
python -m pip install mkdoxy ".[dev]"
Install from source:
pip install git+https://github.com/JakubAndrysek/MkDoxy.git
Quick start
mkdocs.yml
:
site_name: "My MkDoxy documentation"
theme:
name: material
plugins:
- search
- mkdoxy:
projects:
myProjectCpp:
src-dirs: path/to/src/project1
full-doc: True
doxy-cfg:
FILE_PATTERNS: "*.cpp *.h*"
RECURSIVE: True
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you want to change.
Do You Enjoy MkDoxy or Does It Save You Time?
Then definitely consider:
- supporting me on GitHub Sponsors:
![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)
License
This project is licensed under the terms of the MIT license