Description:

mkdocscoverage 1.1.0

MkDocs Coverage Plugin





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_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

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

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter