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.

:material-home-edit: Online Demo and :simple-github: 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

Release files for mkdoxy 1.2.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdoxy 1.2.8
File	Size	Uploaded
mkdoxy-1.2.8.tar.gz	653.7 kB	Aug 29, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdoxy 1.2.8
File	Interpreter	ABI	Platform	Reset
mkdoxy-1.2.8-py3-none-any.whl 44.8 kB Aug 29, 2025	Python 3	none	any	Details

Total release size: 698.6 kB

Release files / mkdoxy-1.2.8.tar.gz

Download URL	mkdoxy-1.2.8.tar.gz
Size	653.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`95129608a332096ca52a7620c024ed33125e830508e5be0639a32766d9e44228`
BLAKE2b-256 checksum How to use checksums	`8e14253c06c0a28b2288e35351a19c83473b11700bf0e82e16bbf668dc0ba45c`
Upload date	Aug 29, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.5`

Release files / mkdoxy-1.2.8-py3-none-any.whl

Download URL	mkdoxy-1.2.8-py3-none-any.whl
Size	44.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`6bcc60a5409fb2b8f845d5ed69aa010f35569ea8ae2208172e1580f0d375b4a1`
BLAKE2b-256 checksum How to use checksums	`4382dd8e3798b2bb75fd10a8f524b2bf8765d2cd396f21912333abffdd1e6666`
Upload date	Aug 29, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.5`