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_name: coverage # default
html_report_dir: htmlcov # default
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.0.0.tar.gz
(6.4 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs_coverage-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29e3c0fc89d1107ee22a0fbe1a9aa927550f97cf2e2682fcad5672ca3f2e14dd |
|
MD5 | 99a56c59bb5dd222e9fc86f495ff7444 |
|
BLAKE2b-256 | 60fa5c9658177896b5513e20fb08d5d9d57be7901ee5d9b6150e315e130b7f9c |