mkdoxy

library1.2.8pypypiunverified

MkDoxy is a MkDocs plugin that integrates Doxygen to generate documentation with code snippets from C/C++ projects. It parses Doxygen XML output and renders it as part of a MkDocs site. Current version 1.2.8, released June 2025. Release cadence: irregular, with several minor versions per year.

devops web-framework

pip install mkdoxy

github ↗package ↗docs ↗

INSTALL

IMPORT

SIG · MKDOXY

mkdoxy

devopspythonv1.2.8

Install

3.1s avg

Import

—

Disk

33MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.2.8 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 33.4MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 3.1s · import 0.000s · 35MB

33MB installed

● package 33MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

MkDoxyPlugin

✓ from mkdoxy import MkDoxyPlugin

✗ from mkdoxy.plugin import MkDoxyPlugin

Add mkdoxy as a plugin in your mkdocs.yml. Ensure Doxygen is installed and you have a Doxyfile configured.

# Add mkdoxy to your mkdocs.yml plugins: # plugins: # - search # - mkdoxy # Minimal configuration in mkdocs.yml: # plugins: # - mkdoxy: # doxygen-path: "Doxyfile" # Path to your Doxyfile # Then run: # mkdocs serve

mkdocs --version

Debug

Known issues

breakingIncompatible with MkDocs versions < 1.4.0 due to missing manifest functionality.

fix

Upgrade MkDocs to >=1.4.0.

affects: MkDocs <1.4.0

gotchaDoxygen must be installed and accessible in PATH, otherwise mkdocs build fails silently or with obscure errors.

fix

Verify Doxygen installation by running 'doxygen --version'.

affects: all

gotchaPlugin does not handle Doxygen XML with missing 'briefdescription' tags well; may cause KeyError.

fix

Ensure Doxygen configuration generates detailed descriptions, or handle missing tags in XML.

affects: <=1.2.8

deprecatedSupport for Python 3.8 and earlier was dropped; requires Python >=3.9.

fix

Upgrade Python to 3.9 or higher.

affects: >=1.2.0

Upgrade

Version history

1.2.8latest on PyPI · released Aug 29, 2025

Audit

Dependencies

mkdocsrequiredRequired as MkDocs plugin.

doxygenrequiredDoxygen executable (system dependency) must be installed separately.

PyYAMLrequiredConfiguration parsing.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/sponsors/jakubandrysek ↗

packagehttps://pypi.org/project/mkdoxy/ ↗

docshttps://mkdoxy.kubaandrysek.cz/ ↗