From c996173b72aa48fd88ef333dd3d0da7caf9f90c7 Mon Sep 17 00:00:00 2001 From: Frank Harkins Date: Tue, 27 Feb 2024 18:08:54 +0000 Subject: [PATCH] Add `tox` instructions to README --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f742fcd34f..21ac41c8b1b 100644 --- a/README.md +++ b/README.md @@ -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