https://github.com/pawamoy/mkdocs-coverage

MkDocs plugin to integrate your coverage HTML report into your site.
https://github.com/pawamoy/mkdocs-coverage

coverage coverage-report mkdocs mkdocs-plugin

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/pawamoy/mkdocs-coverage
• Owner: pawamoy
• License: isc
• Created: 2021-02-03T18:32:20.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-11T18:47:29.000Z (6 months ago)
• Last Synced: 2024-10-15T07:43:48.798Z (2 months ago)
• Topics: coverage, coverage-report, mkdocs, mkdocs-plugin
• Language: Python
• Homepage: https://pawamoy.github.io/mkdocs-coverage
• Size: 1.82 MB
• Stars: 22
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# MkDocs Coverage Plugin

[![ci](https://github.com/pawamoy/mkdocs-coverage/workflows/ci/badge.svg)](https://github.com/pawamoy/mkdocs-coverage/actions?query=workflow%3Aci)

[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/mkdocs-coverage/)

[![pypi version](https://img.shields.io/pypi/v/mkdocs-coverage.svg)](https://pypi.org/project/mkdocs-coverage/)

[![gitpod](https://img.shields.io/badge/gitpod-workspace-708FCC.svg?style=flat)](https://gitpod.io/#https://github.com/pawamoy/mkdocs-coverage)

[![gitter](https://badges.gitter.im/join%20chat.svg)](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!

![coverage index](https://user-images.githubusercontent.com/3999221/106802970-f4376a80-6663-11eb-8665-e9e09f0f4ac0.png)

![coverage module](https://user-images.githubusercontent.com/3999221/106803017-fe596900-6663-11eb-9df9-973755c5b63e.png)