| Name | mkdocs-coverage JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | MkDocs plugin to integrate your coverage HTML report into your site. |
| upload_time | 2024-06-11 18:47:23 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | ISC |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MkDocs Coverage Plugin
[](https://github.com/pawamoy/mkdocs-coverage/actions?query=workflow%3Aci)
[](https://pawamoy.github.io/mkdocs-coverage/)
[](https://pypi.org/project/mkdocs-coverage/)
[](https://gitpod.io/#https://github.com/pawamoy/mkdocs-coverage)
[](https://app.gitter.im/#/room/#mkdocs-coverage:gitter.im)
MkDocs plugin to integrate your coverage HTML report into your site.
## Installation
With `pip`:
```bash
pip install mkdocs-coverage
```
With [`pipx`](https://github.com/pipxproject/pipx):
```bash
python3.8 -m pip install --user pipx
pipx install mkdocs-coverage
```
## Usage
```yaml
# mkdocs.yml
nav:
- Coverage report: coverage.md
plugins:
- coverage:
page_path: coverage # default
html_report_dir: htmlcov # default
```
The page path can be nested:
```yaml
# mkdocs.yml
nav:
- Coverage report: dev/reports/coverage.md
plugins:
- coverage:
page_path: dev/reports/coverage
```
Now serve your documentation,
and go to http://localhost:8000/coverage/
to see your coverage report!
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-coverage",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "=?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>",
"download_url": "https://files.pythonhosted.org/packages/93/64/a9fe7d953d6b02944610a5f7361cdab7532a9f5518ffe890287a9f187f08/mkdocs_coverage-1.1.0.tar.gz",
"platform": null,
"description": "# MkDocs Coverage Plugin\n\n[](https://github.com/pawamoy/mkdocs-coverage/actions?query=workflow%3Aci)\n[](https://pawamoy.github.io/mkdocs-coverage/)\n[](https://pypi.org/project/mkdocs-coverage/)\n[](https://gitpod.io/#https://github.com/pawamoy/mkdocs-coverage)\n[](https://app.gitter.im/#/room/#mkdocs-coverage:gitter.im)\n\nMkDocs plugin to integrate your coverage HTML report into your site.\n\n## Installation\n\nWith `pip`:\n\n```bash\npip install mkdocs-coverage\n```\n\nWith [`pipx`](https://github.com/pipxproject/pipx):\n\n```bash\npython3.8 -m pip install --user pipx\npipx install mkdocs-coverage\n```\n\n## Usage\n\n```yaml\n# mkdocs.yml\nnav:\n- Coverage report: coverage.md\n\nplugins:\n- coverage:\n page_path: coverage # default\n html_report_dir: htmlcov # default\n```\n\nThe page path can be nested:\n\n```yaml\n# mkdocs.yml\nnav:\n- Coverage report: dev/reports/coverage.md\n\nplugins:\n- coverage:\n page_path: dev/reports/coverage\n```\n\nNow serve your documentation,\nand go to http://localhost:8000/coverage/\nto see your coverage report!\n\n\n\n",
"bugtrack_url": null,
"license": "ISC",
"summary": "MkDocs plugin to integrate your coverage HTML report into your site.",
"version": "1.1.0",
"project_urls": {
"Changelog": "https://pawamoy.github.io/mkdocs-coverage/changelog",
"Discussions": "https://github.com/pawamoy/mkdocs-coverage/discussions",
"Documentation": "https://pawamoy.github.io/mkdocs-coverage",
"Funding": "https://github.com/sponsors/pawamoy",
"Gitter": "https://gitter.im/mkdocs-coverage/community",
"Homepage": "https://pawamoy.github.io/mkdocs-coverage",
"Issues": "https://github.com/pawamoy/mkdocs-coverage/issues",
"Repository": "https://github.com/pawamoy/mkdocs-coverage"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ebf096851f1d9809e1cbd1f1545948d3c4bde7abfa3af5965b7ba8d88ec37c11",
"md5": "28960dac5199846d6fb34fc0b8f88da9",
"sha256": "168ca4ebc35ba48309c1f734d0cab0359cd95b205d0d18030d27e73b6a4590d9"
},
"downloads": -1,
"filename": "mkdocs_coverage-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "28960dac5199846d6fb34fc0b8f88da9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6853,
"upload_time": "2024-06-11T18:47:20",
"upload_time_iso_8601": "2024-06-11T18:47:20.649236Z",
"url": "https://files.pythonhosted.org/packages/eb/f0/96851f1d9809e1cbd1f1545948d3c4bde7abfa3af5965b7ba8d88ec37c11/mkdocs_coverage-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9364a9fe7d953d6b02944610a5f7361cdab7532a9f5518ffe890287a9f187f08",
"md5": "69d538964e22d511de14f50c7716d7e4",
"sha256": "a67cc6f6d548b8d6b4b21ecd777f2e3768b49e7a95e54c6df158e7c0f179134c"
},
"downloads": -1,
"filename": "mkdocs_coverage-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "69d538964e22d511de14f50c7716d7e4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5514,
"upload_time": "2024-06-11T18:47:23",
"upload_time_iso_8601": "2024-06-11T18:47:23.773893Z",
"url": "https://files.pythonhosted.org/packages/93/64/a9fe7d953d6b02944610a5f7361cdab7532a9f5518ffe890287a9f187f08/mkdocs_coverage-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-11 18:47:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pawamoy",
"github_project": "mkdocs-coverage",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-coverage"
}
