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.6.tar.gz
(5.4 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs_coverage-0.2.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 88f20c023414bc910b0a274dff030e196393ac819515d6703a3bd97636097acc |
|
MD5 | 10ce76abf1d8f4bdbcb1ec9ae1a43cd6 |
|
BLAKE2b-256 | 3f000fb3f1a36693b98153e279ae5ae1306c2da810e1c62bfd59f0d771f86ca7 |