Skip to content

MkDocs Coverage Plugin¤

ci documentation pypi version gitpod gitter

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

Installation¤

With pip: 

pip install mkdocs-coverage

With pipx: 

python3.8 -m pip install --user pipx
pipx install mkdocs-coverage

Usage¤

# mkdocs.yml

nav:
- Coverage report: coverage.md

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

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

coverage index coverage module