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.

Sign up for GitHub

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

Docs: clarify how multiple values work for various options #2070

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: clarify how multiple values work for various options #2070

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 9 additions & 11 deletions docs/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,11 @@ List of builds to build and skip. Each build has an identifier like `cp38-manyli

When both options are specified, both conditions are applied and only builds with a tag that matches `CIBW_BUILD` and does not match `CIBW_SKIP` will be built.

When setting the options, you can use shell-style globbing syntax, as per [fnmatch](https://docs.python.org/3/library/fnmatch.html) with the addition of curly bracket syntax `{option1,option2}`, provided by [bracex](https://pypi.org/project/bracex/). All the build identifiers supported by cibuildwheel are shown below:
When setting the options, you can use shell-style globbing syntax, as per [fnmatch](https://docs.python.org/3/library/fnmatch.html) with the addition of curly bracket syntax `{option1,option2}`, provided by [bracex](https://pypi.org/project/bracex/).

Separate multiple selectors with a space, e.g. `cp36-macosx_x86_64 pp*`.

All the build identifiers supported by cibuildwheel are shown below:

<div class="build-id-table-marker"></div>

Expand Down Expand Up @@ -361,8 +365,6 @@ See the [cibuildwheel 1 documentation](https://cibuildwheel.pypa.io/en/1.x/) for
CIBW_SKIP: pp*
```

Separate multiple selectors with a space.

!!! tab examples "pyproject.toml"

```toml
Expand Down Expand Up @@ -473,6 +475,7 @@ The build identifiers for those variants have a `t` suffix in their `python_tag`
> Change the architectures built on your machine by default.

A list of architectures to build.
Separate multiple architectures with a space.

On macOS, this option can be used to [cross-compile](faq.md#cross-compiling)
between `x86_64`, `universal2` and `arm64`.
Expand Down Expand Up @@ -532,8 +535,6 @@ This option can also be set using the [command-line option](#command-line)
CIBW_ARCHS_LINUX: "auto aarch64"
```

Separate multiple archs with a space.

!!! tab examples "pyproject.toml"

```toml
Expand Down Expand Up @@ -814,8 +815,6 @@ Platform-specific environment variables are also available:<br/>
CIBW_ENVIRONMENT_LINUX: BUILD_TIME="$(date)" SAMPLE_TEXT="sample text"
```

Separate multiple values with a space.

!!! tab examples "pyproject.toml"

```toml
Expand Down Expand Up @@ -883,8 +882,6 @@ To specify more than one environment variable, separate the variable names by sp
CIBW_ENVIRONMENT_PASS_LINUX: BUILD_TIME SAMPLE_TEXT
```

Separate multiple values with a space.

!!! tab examples "pyproject.toml"

```toml
Expand Down Expand Up @@ -1580,6 +1577,9 @@ tests. This can be used to avoid having to redefine test dependencies in
`CIBW_TEST_REQUIRES` if they are already defined in `pyproject.toml`,
`setup.cfg` or `setup.py`.

Separate multiple items with a comma, e.g. `bar,baz,quux`,
just like you would when installing extras with `pip install foo[bar,baz,quux]`.

Platform-specific environment variables are also available:<br/>
`CIBW_TEST_EXTRAS_MACOS` | `CIBW_TEST_EXTRAS_WINDOWS` | `CIBW_TEST_EXTRAS_LINUX` | `CIBW_TEST_EXTRAS_PYODIDE`

Expand All @@ -1592,8 +1592,6 @@ Platform-specific environment variables are also available:<br/>
CIBW_TEST_EXTRAS: "test,qt"
```

Separate multiple items with a comma.

!!! tab examples "pyproject.toml"

```toml
Expand Down