Skip to content

Commit

Permalink
docs: refine CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: msclock <msclock@qq.com>
  • Loading branch information
msclock committed Jan 4, 2024
1 parent 3afdd37 commit 38fe21d
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Python on your system, skipping ones that are not installed. You can also run
specific jobs:

```console
$ nox -l # List available tasks
$ nox -s lint # Lint only
$ nox -s tests # Python tests
$ nox -s docs -- serve # Build and serve the docs
Expand Down Expand Up @@ -63,15 +64,29 @@ You can also/alternatively run `pre-commit run` (changes only) or
Use pytest to run the unit checks:

```bash
pip install -e .[test]
pytest
```

or

```bash
nox -s tests
```

## Coverage

Use pytest-cov to generate coverage reports:

```bash
pytest --cov=sphinx-deployment
pip install -e .[test]
pytest --cov
```

or

```bash
nox -s tests -- --cov
```

## Building docs
Expand All @@ -88,6 +103,13 @@ You can see a preview with:
nox -s docs -- serve
```

Versioned docs management can be done using:

```bash
nox -s versioned_docs -- --help # to see options
nox -s versioned_docs -- serve # to view the versioned docs
```

## Pre-commit

This project uses pre-commit for all style checking. While you can run it with
Expand Down

0 comments on commit 38fe21d

Please sign in to comment.