Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ask contributors to use tox for final notebook execution. #1365

Merged
merged 5 commits into from
May 14, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,9 @@ This staging environment can be useful to see how the docs are rendering before

## Execute notebooks

Before submitting a new notebook or code changes to a notebook, you must run the notebook using `tox -- --write <path-to-notebook>` and commit the results.
This means we can be sure all notebooks work and that users will see the same results when they run using the environment we recommend.
frankharkins marked this conversation as resolved.
Show resolved Hide resolved

To execute notebooks in a fixed Python environment, first install `tox` using
[pipx](https://pipx.pypa.io/stable/):

Expand Down
Loading