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.
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!
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.3.tar.gz
(6.5 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs_coverage-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3db3ea7869511c51701e1db6962f7431292a3941ab6118a04aafec9513d04bd9 |
|
MD5 | b52cbf24aeb1ce4d17ea6d2321a4e909 |
|
BLAKE2b-256 | 82ec3f50b51bf55d8fb7442e4d872c91666419a7362b4f6c76ad12d037559779 |