Skip to content

Commit 1446529

Browse files
committed
Sort out page titles
1 parent 51649fd commit 1446529

3 files changed

Lines changed: 5 additions & 53 deletions

File tree

docs/faq.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22
title: Tips and tricks
33
---
44

5+
### Troubleshooting
6+
57
If your wheel didn't compile, check the list below for some debugging tips.
68

79
- 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.
810

9-
- 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.
11+
- 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.
1012

1113
- 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.
1214

docs/options.md

Lines changed: 0 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,3 @@
1-
## Options
2-
3-
<div class="toc-grid-marker"></div>
4-
5-
| | | |
6-
|---|---|---|
7-
| **Target wheels** | | |
8-
| `CIBW_PLATFORM` | Override the auto-detected target platform |
9-
| `CIBW_BUILD` | Build only certain Python versions |
10-
| `CIBW_SKIP` | Skip certain Python versions |
11-
| **Build parameters** | | |
12-
| `CIBW_BUILD_VERBOSITY` | Increase or decrease the output of `pip wheel` |
13-
| **Build environment** | | |
14-
| `CIBW_ENVIRONMENT` | Set environment variables needed during the build |
15-
| `CIBW_BEFORE_BUILD` | Execute a shell command preparing each wheel's build |
16-
| `CIBW_MANYLINUX1_X86_64_IMAGE` | Specify an alternative manylinx1 x86_64 docker image |
17-
| `CIBW_MANYLINUX1_I686_IMAGE` | Specify an alternative manylinux1 i686 docker image |
18-
| **Tests** | | |
19-
| `CIBW_TEST_COMMAND` | Execute a shell command to test all built wheels |
20-
| `CIBW_TEST_REQUIRES` | Install Python dependencies before running the tests |
21-
| `CIBW_TEST_EXTRAS` | Install Python dependencies before running the tests using ``extras_require``|
22-
23-
24-
- Target wheels
25-
- `CIBW_PLATFORM`
26-
- Override the auto-detected target platform
27-
- `CIBW_BUILD`
28-
- Build only certain Python versions |
29-
- `CIBW_SKIP`
30-
- Skip certain Python versions |
31-
- Build parameters
32-
- `CIBW_BUILD_VERBOSITY`
33-
- Increase or decrease the output of `pip wheel` |
34-
- Build environment
35-
- `CIBW_ENVIRONMENT`
36-
- Set environment variables needed during the build |
37-
- `CIBW_BEFORE_BUILD`
38-
- Execute a shell command preparing each wheel's build |
39-
- `CIBW_MANYLINUX1_X86_64_IMAGE`
40-
- Specify an alternative manylinx1 x86_64 docker image |
41-
- `CIBW_MANYLINUX1_I686_IMAGE`
42-
- Specify an alternative manylinux1 i686 docker image |
43-
- Tests
44-
- `CIBW_TEST_COMMAND`
45-
- Execute a shell command to test all built wheels |
46-
- `CIBW_TEST_REQUIRES`
47-
- Install Python dependencies before running the tests |
48-
- `CIBW_TEST_EXTRAS`
49-
- Install Python dependencies before running the tests using ``extras_require``|
50-
511
## Options summary
522

533
<div class="options-toc"></div>

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ extra_javascript:
1515

1616
nav:
1717
- Home: index.md
18-
- "Setup guide": setup.md
19-
- "Options": options.md
18+
- setup.md
19+
- options.md
2020
- deliver-to-pypi.md
2121
- faq.md
2222
- contributing.md

0 commit comments

Comments
 (0)