Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Temporarily removing instructions for `docs`
  • Loading branch information
uwcdc authored Dec 1, 2023
1 parent 49fba9e commit bfc0e60
Showing 1 changed file with 0 additions and 15 deletions.
15 changes: 0 additions & 15 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ specific jobs:
```console
$ nox -s lint # Lint only
$ nox -s tests # Python tests
$ nox -s docs -- serve # Build and serve the docs
$ nox -s build # Make an SDist and wheel
```

Expand Down Expand Up @@ -74,20 +73,6 @@ Use pytest-cov to generate coverage reports:
pytest --cov=caustics
```

# Building docs

You can build the docs using:

```bash
nox -s docs
```

You can see a preview with:

```bash
nox -s docs -- serve
```

# Pre-commit

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

0 comments on commit bfc0e60

Please sign in to comment.