MkDoxy¶

MkDoxy plugin for MkDocs generates API documentation based on Doxygen comments and code snippets in your markdown files.

🤝 Looking for a maintainer

MkDoxy has been quiet lately — I no longer have the time to give it the care it deserves, and I'd love for it to stay alive and keep helping people. If you use MkDoxy and would like to take part in its day-to-day maintenance (triaging issues, reviewing PRs, shipping releases), I'd be happy to hear from you. Improving the automated test suite would be a great way to start.

The MkDocs ecosystem is also in flux (see MkDocs 2.0, ProperDocs, Zensical), so the project's future direction is open for discussion.

Interested? Open a discussion or email email@kubaandrysek.cz and tell me a bit about yourself and your experience with open source.

Some features may not work properly. More information in Discussions and Issues.

Online Demo and Demo source-code ¶

Feature List - Installation - Quick start

Feature List¶

Easy to use:: Just add mkdoxy to your mkdocs.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.

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: # 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

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:

License¶

This project is licensed under the terms of the MIT license