Registry / testing / mkdocs-coverage

mkdocs-coverage

JSON →
library2.0.0pypypi✓ verified 80d ago

MkDocs plugin to integrate your Coverage.py HTML report into your MkDocs site. Version 2.0.0 removes deprecated code and requires MkDocs 1.6+. It supports inserting coverage reports as new pages or into existing pages via a placeholder token.

testingdevops
pip install mkdocs-coverage
github ↗package ↗homepage ↗docs ↗changelog ↗
INSTALL
IMPORT
SIG · MKDOCS-COVERAGE
M
mkdocs-coverage
testingpythonv2.0.0
Install
3.0s avg
Import
—
Disk
32MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.9–3.13
musl
3.9–3.13
Install & Compatibility
Where this runs
tested against v2.0.0 · 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 · 33MB
glibc
py 3.10–3.95 runs
installs and imports cleanly · install 3.0s · import 0.000s · 34MB
32MB installed
● package 32MB
Code
Verified usage

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

MkDocsCoveragePlugin
✓ from mkdocs_coverage import MkDocsCoveragePlugin
✗ from mkdocs_coverage import MkDocsCoverage
MkDocsCoverageConfig
✓ from mkdocs_coverage import MkDocsCoverageConfig
annotations
✓ from mkdocs_coverage import annotations

Add the coverage plugin to your mkdocs.yml and run `coverage html` plus `mkdocs serve`.

# mkdocs.yml plugins: - search - coverage
Debug
Known issues
breakingv2.0.0 removed deprecated code; ensure all configurations use the updated option names (e.g., `page_path` instead of `page_name`).
fix
Rename `page_name` to `page_path` in mkdocs.yml and any custom configurations.
affects: >=2.0.0
deprecatedThe `page_name` option was deprecated in v1.2.0 and removed in v2.0.0.
fix
Use `page_path` instead, which supports nested paths like 'coverage/index.md'.
affects: <=1.2.0
breakingv1.1.0 dropped support for MkDocs <1.6, requiring MkDocs 1.6+.
fix
Upgrade MkDocs to >=1.6.
affects: >=1.1.0
gotchaThe plugin expects the coverage HTML report to already exist before mkdocs is run. It does not generate the report itself.
fix
Run `coverage html` before `mkdocs build` or `mkdocs serve`.
affects: all
gotchaIf using the `placeholder` option, the placeholder string must be exactly `<!--coverage-->` (case-sensitive).
fix
Insert `<!--coverage-->` in the markdown file where the report should appear.
affects: >=1.2.0
Upgrade
Version history
2.0.0latest on PyPI · released Sep 11, 2025
Audit
Dependencies

No dependency data recorded yet.

Agent activity
2 hits · last 30 days
node
2
Resources
githubhttps://github.com/pawamoy/mkdocs-coverage ↗
packagehttps://pypi.org/project/mkdocs-coverage/ ↗
homepagehttps://pawamoy.github.io/mkdocs-coverage ↗
docshttps://pawamoy.github.io/mkdocs-coverage ↗
changeloghttps://pawamoy.github.io/mkdocs-coverage/changelog ↗