diff --git a/README.md b/README.md index 8fe169eea..b346a91b7 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,15 @@ jobs: For more information, including PyPI deployment, and the use of other CI services or the dedicated GitHub Action, check out the [documentation](https://cibuildwheel.readthedocs.org) and the [examples](https://github.com/pypa/cibuildwheel/tree/main/examples). +How it works +------------ + +The following diagram summarises the steps that cibuildwheel takes on each platform. + +![](docs/data/how-it-works.png) + +Explore an interactive version of this diagram [in the docs](https://cibuildwheel.readthedocs.io/en/stable/#how-it-works). + Options ------- @@ -117,7 +126,7 @@ Options | | [`CIBW_ENVIRONMENT_PASS_LINUX`](https://cibuildwheel.readthedocs.io/en/stable/options/#environment-pass) | Set environment variables on the host to pass-through to the container during the build. | | | [`CIBW_BEFORE_ALL`](https://cibuildwheel.readthedocs.io/en/stable/options/#before-all) | Execute a shell command on the build system before any wheels are built. | | | [`CIBW_BEFORE_BUILD`](https://cibuildwheel.readthedocs.io/en/stable/options/#before-build) | Execute a shell command preparing each wheel's build | -| | [`CIBW_REPAIR_WHEEL_COMMAND`](https://cibuildwheel.readthedocs.io/en/stable/options/#repair-wheel-command) | Execute a shell command to repair each (non-pure Python) built wheel | +| | [`CIBW_REPAIR_WHEEL_COMMAND`](https://cibuildwheel.readthedocs.io/en/stable/options/#repair-wheel-command) | Execute a shell command to repair each built wheel | | | [`CIBW_MANYLINUX_*_IMAGE`
`CIBW_MUSLLINUX_*_IMAGE`](https://cibuildwheel.readthedocs.io/en/stable/options/#linux-image) | Specify alternative manylinux / musllinux Docker images | | | [`CIBW_DEPENDENCY_VERSIONS`](https://cibuildwheel.readthedocs.io/en/stable/options/#dependency-versions) | Specify how cibuildwheel controls the versions of the tools it uses | | **Testing** | [`CIBW_TEST_COMMAND`](https://cibuildwheel.readthedocs.io/en/stable/options/#test-command) | Execute a shell command to test each built wheel | diff --git a/docs/data/how-it-works.png b/docs/data/how-it-works.png new file mode 100644 index 000000000..0306280a5 Binary files /dev/null and b/docs/data/how-it-works.png differ diff --git a/docs/diagram.md b/docs/diagram.md new file mode 100644 index 000000000..d0557b4fb --- /dev/null +++ b/docs/diagram.md @@ -0,0 +1,487 @@ +
+
+ + +
+
+
+ +
+
+ Manylinux Docker container +
+
+ +
+
Test virtualenv
+
+
+
+ + +
Linux
+
macOS
+
Windows
+ +
+
For each version of Python
+
+
+
If tests are configured
+
+ +
+ +
+
+
+
+
+
+
+ {{action.label}} +
+
+ +
+
+
+ + + + + + diff --git a/docs/extra.css b/docs/extra.css index e3599627e..a971d3980 100644 --- a/docs/extra.css +++ b/docs/extra.css @@ -3,6 +3,7 @@ body { overflow-wrap: break-word; + overflow-x: hidden; } p { diff --git a/docs/index.md b/docs/index.md index 6cc7ccfd5..897eaa10f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,3 +9,14 @@ title: Home %} To get started, head over to the [setup guide](setup.md). + +How it works +------------ + +This diagram summarises the steps that cibuildwheel takes on each platform to build your package's wheels. + +{% + include-markdown "diagram.md" +%} + +This isn't exhaustive, for a full list of the things cibuildwheel can do, check the [options](options.md) page. diff --git a/docs/options.md b/docs/options.md index c9d7b7425..baf4bfb9b 100644 --- a/docs/options.md +++ b/docs/options.md @@ -783,7 +783,7 @@ Platform-specific environment variables are also available:
### `CIBW_REPAIR_WHEEL_COMMAND` {: #repair-wheel-command} -> Execute a shell command to repair each (non-pure Python) built wheel +> Execute a shell command to repair each built wheel Default: