Skip to content

Commit

Permalink
docs: fix update scripts usage (#2067)
Browse files Browse the repository at this point in the history
* Update contributing.md

* Update options.md

* Update options.md

* Update docs/contributing.md

Co-authored-by: Matthieu Darbois <[email protected]>

* Update contributing.md

* Apply suggestions from code review

Co-authored-by: Matthieu Darbois <[email protected]>

---------

Co-authored-by: Henry Schreiner <[email protected]>
Co-authored-by: Matthieu Darbois <[email protected]>
  • Loading branch information
3 people authored Nov 18, 2024
1 parent b882b84 commit aac31ae
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,11 @@ nox -s docs # Build and serve the documentation
nox -s build # Make SDist and wheel
```

More advanced users can run the update scripts. `update_pins` should work directly, but `update_constraints` needs all versions of Python installed. If you don't want to do that locally, a fast way to run it to use docker to run nox:
More advanced users can run the update scripts:

```console
docker run --rm -itv $PWD:/src -w /src quay.io/pypa/manylinux_2_24_x86_64:latest pipx run nox -s update_constraints
nox -s update_constraints # update all constraints files in cibuildwheel/resources
nox -s update_pins # update tools, python interpreters & docker images used by cibuildwheel
```

## Maintainer notes
Expand Down

0 comments on commit aac31ae

Please sign in to comment.