Skip to main content

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

Project description

MkDocs Coverage Plugin

ci documentation pypi version gitter

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

Project details


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.1.0.tar.gz (4.2 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_coverage-0.1.0-py3-none-any.whl (6.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page