MkDocs Coverage Plugin
MkDocs plugin to integrate your coverage HTML report into your site.
Installation
pip install mkdocs-coverage
python3.8 -m pip install --user pipx
pipx install mkdocs-coverage
Usage
# mkdocs.yml
nav:
- Coverage report: coverage.md
plugins:
- coverage:
page_path: coverage # default
html_report_dir: htmlcov # default
The page path can be nested:
# mkdocs.yml
nav:
- Coverage report: dev/reports/coverage.md
plugins:
- coverage:
page_path: dev/reports/coverage
If the page doesn't exist, it will be created. If the page exists, the coverage report will be appended at the end.
You can choose where to insert the coverage report in the page thanks to the placeholder setting:
# mkdocs.yml
nav:
- Coverage report: dev/coverage.md # existing page
plugins:
- coverage:
page_path: dev/coverage
placeholder: "[INSERT REPORT HERE]"
In your page:
# Some page
Some text.
## Coverage report
[INSERT REPORT HERE]
The plugin will replace any such string with the coverage report. The default placeholder is <!-- mkdocs-coverage -->.
Now serve your documentation, and go to http://localhost:8000/coverage/ to see your coverage report!
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-coverage 2.0.0
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-2.0.0.tar.gz | 31.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_coverage-2.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 38.1 kB
Release files / mkdocs_coverage-2.0.0.tar.gz
| Download URL | mkdocs_coverage-2.0.0.tar.gz |
|---|---|
| Size | 31.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
628568ae5364eec06581bd6d7d83a56f9682a57350e73f07c298d5e104c7f69a
|
|
BLAKE2b-256 checksum How to use checksums |
ed993dc73a10a97b3b2f1071051987e0653b0de16b284ab669e5060c819c2609
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.6
|
Release files / mkdocs_coverage-2.0.0-py3-none-any.whl
| Download URL | mkdocs_coverage-2.0.0-py3-none-any.whl |
|---|---|
| Size | 6.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7df7449811ecea1802d42344d925a34eac9a084f22d3140bae234fad8cefa1ad
|
|
BLAKE2b-256 checksum How to use checksums |
90b7463c1c3ecc4c2e7bcb73bdc348ab356553ded0e39d25e6f1eee9c6f9c431
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.6
|
