mkdocs-coverage 0.2.1

MkDocs plugin to integrate your coverage HTML report into your site.

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!