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.7 -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-0.2.7.tar.gz
(6.4 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs_coverage-0.2.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfb11ab6c7d6c1e30495d0cbb78893937b0715387ea4862d269980300667b0e3 |
|
MD5 | 2e6d652e24832211ccf6e85d7c0b71eb |
|
BLAKE2b-256 | 8d8990c1165679be422415ad0e03a8a75e202e0f415b672c1b3bd985e821b4ee |