MkDocs plugin to integrate your coverage HTML report into your site.
Project description
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!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mkdocs_coverage-1.1.0.tar.gz
(5.5 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs_coverage-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 168ca4ebc35ba48309c1f734d0cab0359cd95b205d0d18030d27e73b6a4590d9 |
|
MD5 | 28960dac5199846d6fb34fc0b8f88da9 |
|
BLAKE2b-256 | ebf096851f1d9809e1cbd1f1545948d3c4bde7abfa3af5965b7ba8d88ec37c11 |