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
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.1.tar.gz
(5.5 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs-coverage-0.2.1.tar.gz.
File metadata
- Download URL: mkdocs-coverage-0.2.1.tar.gz
- Upload date:
- Size: 5.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.6.9 Linux/5.10.11-arch1-1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
32a3581b2c4d44289d2d17dd1d9dca36bc640db699bbe007803370b52780b37e
|
|
| MD5 |
77d92d925e50a35cf7ca64709d9fef10
|
|
| BLAKE2b-256 |
ffb52a3c11a355fc7117f400d57c4365009fed6d4ae637e7359c7fc3f6efa401
|
File details
Details for the file mkdocs_coverage-0.2.1-py3-none-any.whl.
File metadata
- Download URL: mkdocs_coverage-0.2.1-py3-none-any.whl
- Upload date:
- Size: 7.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.6.9 Linux/5.10.11-arch1-1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0d860b6d5852933e00ff14151600bfc6495349f876b2a7c3b53cb4b972591754
|
|
| MD5 |
bb5f1a23ad2deb7636415827fc3ba354
|
|
| BLAKE2b-256 |
98ec2853aa76aaa7709c22a93f510c272688d6fd4802999517bac0da8c4b37cd
|
