From 1446529f7c81637f76f2f20c32a8111aab111be2 Mon Sep 17 00:00:00 2001 From: Joe Rickerby Date: Sun, 3 Nov 2019 19:06:33 +0000 Subject: [PATCH] Sort out page titles --- docs/faq.md | 4 +++- docs/options.md | 50 ------------------------------------------------- mkdocs.yml | 4 ++-- 3 files changed, 5 insertions(+), 53 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 461225e9..aa6faec8 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -2,11 +2,13 @@ title: Tips and tricks --- +### Troubleshooting + If your wheel didn't compile, check the list below for some debugging tips. - A mistake in your config. To quickly test your config without doing a git push and waiting for your code to build on CI, you can test the Linux build in a Docker container. On Mac or Linux, with Docker running, try `cibuildwheel --platform linux`. You'll have to bring your config into the current environment first. -- Missing dependency. You might need to install something on the build machine. You can do this in `.travis.yml`, `appveyor.yml`, or `.circleci/config.yml`, with apt-get, brew or choco. Given how the Linux build works, you'll need to use the [CIBW_BEFORE_BUILD](options.md#before-build) option. +- Missing dependency. You might need to install something on the build machine. You can do this in `.travis.yml`, `appveyor.yml`, or `.circleci/config.yml`, with apt-get, brew or choco. Given how the Linux build works, you'll need to use the [`CIBW_BEFORE_BUILD`](options.md#before-build) option. - Windows: missing C feature. The Windows C compiler doesn't support C language features invented after 1990, so you'll have to backport your C code to C90. For me, this mostly involved putting my variable declarations at the top of the function like an animal. diff --git a/docs/options.md b/docs/options.md index 48973e4e..c38bf78f 100644 --- a/docs/options.md +++ b/docs/options.md @@ -1,53 +1,3 @@ -## Options - -
- -| | | | -|---|---|---| -| **Target wheels** | | | -| `CIBW_PLATFORM` | Override the auto-detected target platform | -| `CIBW_BUILD` | Build only certain Python versions | -| `CIBW_SKIP` | Skip certain Python versions | -| **Build parameters** | | | -| `CIBW_BUILD_VERBOSITY` | Increase or decrease the output of `pip wheel` | -| **Build environment** | | | -| `CIBW_ENVIRONMENT` | Set environment variables needed during the build | -| `CIBW_BEFORE_BUILD` | Execute a shell command preparing each wheel's build | -| `CIBW_MANYLINUX1_X86_64_IMAGE` | Specify an alternative manylinx1 x86_64 docker image | -| `CIBW_MANYLINUX1_I686_IMAGE` | Specify an alternative manylinux1 i686 docker image | -| **Tests** | | | -| `CIBW_TEST_COMMAND` | Execute a shell command to test all built wheels | -| `CIBW_TEST_REQUIRES` | Install Python dependencies before running the tests | -| `CIBW_TEST_EXTRAS` | Install Python dependencies before running the tests using ``extras_require``| - - -- Target wheels - - `CIBW_PLATFORM` - - Override the auto-detected target platform - - `CIBW_BUILD` - - Build only certain Python versions | - - `CIBW_SKIP` - - Skip certain Python versions | -- Build parameters - - `CIBW_BUILD_VERBOSITY` - - Increase or decrease the output of `pip wheel` | -- Build environment - - `CIBW_ENVIRONMENT` - - Set environment variables needed during the build | - - `CIBW_BEFORE_BUILD` - - Execute a shell command preparing each wheel's build | - - `CIBW_MANYLINUX1_X86_64_IMAGE` - - Specify an alternative manylinx1 x86_64 docker image | - - `CIBW_MANYLINUX1_I686_IMAGE` - - Specify an alternative manylinux1 i686 docker image | -- Tests - - `CIBW_TEST_COMMAND` - - Execute a shell command to test all built wheels | - - `CIBW_TEST_REQUIRES` - - Install Python dependencies before running the tests | - - `CIBW_TEST_EXTRAS` - - Install Python dependencies before running the tests using ``extras_require``| - ## Options summary
diff --git a/mkdocs.yml b/mkdocs.yml index a0ada14e..43e5be2d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,8 +15,8 @@ extra_javascript: nav: - Home: index.md - - "Setup guide": setup.md - - "Options": options.md + - setup.md + - options.md - deliver-to-pypi.md - faq.md - contributing.md