MkDocs Coverage Plugin
MkDocs plugin to integrate your coverage HTML report into your site.
Requirements
MkDocs Coverage Plugin requires Python 3.6 or above.
To install Python 3.6, I recommend using pyenv.
# install pyenv
git clone https://github.com/pyenv/pyenv ~/.pyenv
# setup pyenv (you should also put these three lines in .bashrc or similar)
export PATH="${HOME}/.pyenv/bin:${PATH}"
export PYENV_ROOT="${HOME}/.pyenv"
eval "$(pyenv init -)"
# install Python 3.6
pyenv install 3.6.12
# make it available globally
pyenv global system 3.6.12
Installation
With pip:
python3.6 -m pip install mkdocs-coverage
With pipx:
python3.6 -m pip install --user pipx
pipx install --python python3.6 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!
1 maintainer
Release files for mkdocs-coverage 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs-coverage-0.2.1.tar.gz | 5.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_coverage-0.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 13.4 kB
Release files / mkdocs-coverage-0.2.1.tar.gz
| Download URL | mkdocs-coverage-0.2.1.tar.gz |
|---|---|
| Size | 5.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
32a3581b2c4d44289d2d17dd1d9dca36bc640db699bbe007803370b52780b37e
|
|
BLAKE2b-256 checksum How to use checksums |
ffb52a3c11a355fc7117f400d57c4365009fed6d4ae637e7359c7fc3f6efa401
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.4 CPython/3.6.9 Linux/5.10.11-arch1-1
|
Release files / mkdocs_coverage-0.2.1-py3-none-any.whl
| Download URL | mkdocs_coverage-0.2.1-py3-none-any.whl |
|---|---|
| Size | 7.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0d860b6d5852933e00ff14151600bfc6495349f876b2a7c3b53cb4b972591754
|
|
BLAKE2b-256 checksum How to use checksums |
98ec2853aa76aaa7709c22a93f510c272688d6fd4802999517bac0da8c4b37cd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.4 CPython/3.6.9 Linux/5.10.11-arch1-1
|
