Skip to content

Commit

Permalink
Add tox instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
frankharkins committed Feb 27, 2024
1 parent abd5480 commit c996173
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,13 @@ page, click "Summary", then download "Executed notebooks".
## Lint notebooks

We use [`squeaky`](https://github.com/frankharkins/squeaky) to lint our
notebooks. To check if a notebook needs linting:
notebooks. First install `tox` using [pipx](https://pipx.pypa.io/stable/).

```sh
pipx install tox
```

To check if a notebook needs linting:

```sh
# Check all notebooks in ./docs
Expand Down

0 comments on commit c996173

Please sign in to comment.