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
- Easy to use:: Just add
mkdoxy
to yourmkdocs.yml
and configure the path to your source code. - Code snippets: Generate code snippets in place of your standard Markdown documentation.
- Multiple projects: Support for multiple projects in one documentation (e.g. C and Python).
- Multiple source directories: Configure multiple source directories in one project.
- Custom Jinja templates: Define custom Jinja templates for rendering Doxygen documentation.
- Custom Doxygen configuration: Specify custom Doxygen configuration for each project.
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
mkdocs.yml
:
site_name: "My MkDoxy documentation"
theme:
name: material
plugins:
- search
- mkdoxy:
projects:
myProjectCpp: # name of project must be alphanumeric numbers (without spaces)
src-dirs: path/to/src/project1 # path to source code (support multiple paths separated by space) => INPUT
full-doc: True # if you want to generate full documentation
doxy-cfg: # standard doxygen configuration (key: value)
FILE_PATTERNS: "*.cpp *.h*" # specify file patterns to filter out
RECURSIVE: True # recursive search in source directories
Pull requests are welcome. For major changes, please open an issue first to discuss what you want to change.
Then definitely consider:
This project is licensed under the terms of the MIT license