Skip to content

Commit

Permalink
docs: Add instructions on how to view the coverage webpage
Browse files Browse the repository at this point in the history
  • Loading branch information
Jpnock committed Jan 30, 2024
1 parent 8f1f1d9 commit 033870e
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion docs/coverage.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,18 @@ This will generate a webpage `coverage/index.html` with a listing of all the sou

![Index.html screenshot](./coverage_example.png)

It can also be used automatically on all test files by running `./test.sh coverage`.
It can also be used automatically on all test files by running `./test.sh coverage`.

## Viewing the coverage webpage

You can view the webpage in your browser by navigating to the coverage directory and running the following command:

```python3 -m http.server```

For example:

```console
user@host:/workspaces/langproc-cw# cd coverage
user@host:/workspaces/langproc-cw/coverage# python3 -m http.server
Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...
```

0 comments on commit 033870e

Please sign in to comment.