Skip to content

Commit

Permalink
Mention test/requirements.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
patrick-kidger authored Nov 11, 2024
1 parent ada5229 commit 0cb19e9
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pip install pre-commit
pre-commit install
```

These hooks use Black and isort to format the code, and flake8 to lint it.
These hooks use ruff to lint and format the code, and pyright to type-check it.

---

Expand All @@ -34,7 +34,7 @@ Now make your changes. Make sure to include additional tests if necessary.
Next verify the tests all pass:

```bash
pip install pytest
pip install -r test/requirements.txt
pytest
```

Expand All @@ -54,12 +54,9 @@ Make your changes. You can then build the documentation by doing

```bash
pip install -r docs/requirements.txt
mkdocs build
mkdocs serve
```
Then doing `Control-C`, and running:
```
mkdocs serve
```
(So you run `mkdocs serve` twice.)
(So you run `mkdocs` commands twice; our doc stack is a bit weird and needs this to get the correct module names in the documentation.)

You can then see your local copy of the documentation by navigating to `localhost:8000` in a web browser.

0 comments on commit 0cb19e9

Please sign in to comment.