跳转到主要内容

MkDocs插件,用于将覆盖率HTML报告集成到您的网站中。

项目描述

MkDocs覆盖率插件

ci documentation pypi version gitpod gitter

MkDocs插件,用于将覆盖率HTML报告集成到您的网站中。

安装

使用pip

pip install mkdocs-coverage

使用pipx

python3.8 -m pip install --user pipx
pipx install mkdocs-coverage

使用方法

# mkdocs.yml
nav:
- Coverage report: coverage.md

plugins:
- coverage:
    page_path: coverage  # default
    html_report_dir: htmlcov  # default

页面路径可以是嵌套的

# mkdocs.yml
nav:
- Coverage report: dev/reports/coverage.md

plugins:
- coverage:
    page_path: dev/reports/coverage

现在提供您的文档,然后转到http://localhost:8000/coverage/ 以查看您的覆盖率报告!

coverage index coverage module

项目详情


下载文件

下载适合您平台的应用程序。如果您不确定要选择哪个,请了解更多关于安装包的信息。

源分发

mkdocs_coverage-1.1.0.tar.gz (5.5 kB 查看哈希值)

上传于 来源

构建分发

mkdocs_coverage-1.1.0-py3-none-any.whl (6.9 kB 查看哈希值)

上传于 Python 3

由以下支持