MkDocs Coverage Plugin

MkDocs plugin to integrate your coverage HTML report into your site.

Installation

pip install mkdocs-coverage

Usage

# mkdocs.yml
nav:
- Coverage report: coverage.md

plugins:
- coverage:
    page_path: coverage  # default
    html_report_dir: htmlcov  # default

The page path can be nested:

# mkdocs.yml
nav:
- Coverage report: dev/reports/coverage.md

plugins:
- coverage:
    page_path: dev/reports/coverage

If the page doesn't exist, it will be created. If the page exists, the coverage report will be appended at the end. You can choose where to insert the coverage report in the page thanks to the placeholder setting:

# mkdocs.yml
nav:
- Coverage report: dev/coverage.md  # existing page

plugins:
- coverage:
    page_path: dev/coverage
    placeholder: "[INSERT REPORT HERE]"

In your page:

# Some page

Some text.

## Coverage report

[INSERT REPORT HERE]

The plugin will replace any such string with the coverage report. The default placeholder is .

Now serve your documentation, and go to http://localhost:8000/coverage/ to see your coverage report!

coverage index coverage module

Metadata

Release files for mkdocs-coverage 2.0.1

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

Source distribution (sdist)

Source distribution for mkdocs-coverage 2.0.1
File	Size	Uploaded
mkdocs_coverage-2.0.1.tar.gz	32.9 kB	Oct 6, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-coverage 2.0.1
File	Interpreter	ABI	Platform	Reset
mkdocs_coverage-2.0.1-py3-none-any.whl 8.9 kB Oct 6, 2026	Python 3	none	any	Details

Total release size: 41.9 kB

Release files / mkdocs_coverage-2.0.1.tar.gz

Download URL	mkdocs_coverage-2.0.1.tar.gz
Size	32.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`f3e14885bb39f154f7877af315de0fdd62ff49d53d4a86589529751dcd3be8b8`
BLAKE2b-256 checksum How to use checksums	`4a92fece907523b33e50522dd72f56029e93be988ea37b208c499aaf20348c3f`
Upload date	Oct 6, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.8`

Release files / mkdocs_coverage-2.0.1-py3-none-any.whl

Download URL	mkdocs_coverage-2.0.1-py3-none-any.whl
Size	8.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`ec1e5c89b0ef206d2f5ac7ff537c58c780d9fc343e0ac4e962842ec97b699c13`
BLAKE2b-256 checksum How to use checksums	`bb6f56af467812a7b12d9a1ffe0a855f5e73027605514a795cbd9ed0c88539c5`
Upload date	Oct 6, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.8`