diff --git a/docs/changelog.md b/docs/changelog.md index 1bce05a9..2b465a91 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -2,6 +2,8 @@ title: Changelog --- +# Changelog + ### v2.9.0 _11 August 2022_ diff --git a/docs/contributing.md b/docs/contributing.md index 24566e4e..097fa6e2 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -2,6 +2,8 @@ title: Contributing --- +# Contributing + Wheel-building can be pretty complex. We expect users to find edge-cases - please help the rest of the community out by documenting these, adding features to support them, and reporting bugs. If you have an idea for a modification or feature, it's probably best to raise an issue first and discuss it with the maintainer team. Once we have rough consensus on a design, begin work in a PR. diff --git a/docs/cpp_standards.md b/docs/cpp_standards.md index 468e4eb1..93a548a0 100644 --- a/docs/cpp_standards.md +++ b/docs/cpp_standards.md @@ -2,6 +2,8 @@ title: Modern C++ standards --- +# Modern C++ standards + Building Python wheels with modern C++ standards (C++11 and later) requires a few tricks. diff --git a/docs/deliver-to-pypi.md b/docs/deliver-to-pypi.md index a81abb4e..948662e3 100644 --- a/docs/deliver-to-pypi.md +++ b/docs/deliver-to-pypi.md @@ -2,6 +2,8 @@ title: Delivering to PyPI --- +# Delivering to PyPI + After you've built your wheels, you'll probably want to deliver them to PyPI. ## Manual method diff --git a/docs/extra.css b/docs/extra.css index a971d398..0c95b52f 100644 --- a/docs/extra.css +++ b/docs/extra.css @@ -4,6 +4,7 @@ body { overflow-wrap: break-word; overflow-x: hidden; + -webkit-font-smoothing: antialiased; } p { @@ -105,10 +106,10 @@ h1, h2, h3, h4, h5, h6 { .code-block-filename + pre code { padding-top: 0.9em; } - +/* .toctree-l3 { border-left: 10px solid transparent; -} +} */ /* import font awesome 4 for icons */ @import url(https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css); @@ -226,3 +227,84 @@ h1, h2, h3, h4, h5, h6 { padding-right: 0; margin-bottom: 0.5em; } + +/* theme fix-ups */ + +.rst-content code, .rst-content tt, code { + /* border: none; */ + /* background-color: #f0f1f1; */ + color: inherit; +} +.rst-content pre code { + border: none; +} + +.rst-content h1 code, +.rst-content h2 code, +.rst-content h3 code, +.rst-content h4 code, +.rst-content h5 code, +.rst-content h6 code { + border: none; + color: inherit; + background-color: #f0f1f1; + font-size: 100%; +} + + +/* expand all the toctree entries */ +.wy-menu-vertical .toctree-l1.current .toctree-l2>ul, +.wy-menu-vertical .toctree-l2.current .toctree-l3>ul, +.wy-menu-vertical .toctree-l3.current .toctree-l4>ul, +.wy-menu-vertical .toctree-l4.current .toctree-l5>ul, +.wy-menu-vertical .toctree-l5.current .toctree-l6>ul, +.wy-menu-vertical .toctree-l6.current .toctree-l7>ul, +.wy-menu-vertical .toctree-l7.current .toctree-l8>ul, +.wy-menu-vertical .toctree-l8.current .toctree-l9>ul, +.wy-menu-vertical .toctree-l9.current .toctree-l10>ul, +.wy-menu-vertical .toctree-l10.current .toctree-l11>ul { + display: block; +} + +/* hide all the buttons */ +.wy-menu-vertical li.current>a button.toctree-expand, +.wy-menu-vertical li.on a button.toctree-expand, +.wy-menu-vertical li.toctree-l2 button.toctree-expand, +.wy-menu-vertical li a button.toctree-expand { + display: none; +} + +/* toctree layout improvements */ +.wy-menu-vertical a { + padding: 0.4em 1.2em; +} +.wy-menu-vertical li.current>a, +.wy-menu-vertical li.on a { + font-weight: normal; + padding: 0.4em 1.2em; + /* border-right: 1px solid #f0f0f0; */ +} +.wy-menu-vertical li.current a { + padding: 0.4em 1.2em; +} +.wy-menu-vertical li.toctree-l3 a, +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a { + padding-left: 1.8em; +} +.wy-menu-vertical li.toctree-l2.current>a { + padding: 0.4em 1.2em; +} +.wy-menu-vertical li.toctree-l2.current>a, +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a { + background: transparent; +} +.wy-menu-vertical li.toctree-l2.current>a:hover, +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a:hover { + background: #d6d6d6; +} +.wy-menu-vertical li.current>a.current { + background: #fafafa !important; +} +.wy-menu-vertical li.current a { + +} diff --git a/docs/faq.md b/docs/faq.md index 85314cd3..433ea133 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -2,6 +2,8 @@ title: Tips and tricks --- +# Tips and tricks + ## Tips ### Linux builds in containers diff --git a/docs/options.md b/docs/options.md index b6e0b0c5..167f97d0 100644 --- a/docs/options.md +++ b/docs/options.md @@ -1,3 +1,5 @@ +# Options + ## Setting options cibuildwheel can either be configured using environment variables, or from diff --git a/docs/setup.md b/docs/setup.md index 2dce1f5b..0cb4d6c9 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -2,7 +2,9 @@ title: 'Setup' --- -# Run cibuildwheel locally (optional) {: #local} +# Setup + +## Run cibuildwheel locally (optional) {: #local} Before getting to CI setup, it can be convenient to test cibuildwheel locally to quickly iterate and track down issues without even touching CI. @@ -137,9 +139,9 @@ You can override the cache folder using the ``CIBW_CACHE_PATH`` environment vari ``` -# Configure a CI service +## Configure a CI service -## GitHub Actions [linux/mac/windows] {: #github-actions} +### GitHub Actions [linux/mac/windows] {: #github-actions} To build Linux, Mac, and Windows wheels using GitHub Actions, create a `.github/workflows/build_wheels.yml` file in your repo. @@ -235,7 +237,7 @@ For more info on this file, check out the [docs](https://help.github.com/en/acti [`examples/github-deploy.yml`](https://github.com/pypa/cibuildwheel/blob/main/examples/github-deploy.yml) extends this minimal example with a demonstration of how to automatically upload the built wheels to PyPI. -## Azure Pipelines [linux/mac/windows] {: #azure-pipelines} +### Azure Pipelines [linux/mac/windows] {: #azure-pipelines} To build Linux, Mac, and Windows wheels on Azure Pipelines, create a `azure-pipelines.yml` file in your repo. @@ -249,7 +251,7 @@ Commit this file, enable building of your repo on Azure Pipelines, and push. Wheels will be stored for you and available through the Pipelines interface. For more info on this file, check out the [docs](https://docs.microsoft.com/en-us/azure/devops/pipelines/yaml-schema). -## Travis CI [linux/windows] {: #travis-ci} +### Travis CI [linux/windows] {: #travis-ci} To build Linux and Windows wheels on Travis CI, create a `.travis.yml` file in your repo. @@ -265,7 +267,7 @@ Then setup a deployment method by following the [Travis CI deployment docs](http [`examples/travis-ci-deploy.yml`](https://github.com/pypa/cibuildwheel/blob/main/examples/travis-ci-deploy.yml) extends this minimal example with a demonstration of how to automatically upload the built wheels to PyPI. -## AppVeyor [linux/mac/windows] {: #appveyor} +### AppVeyor [linux/mac/windows] {: #appveyor} To build Linux, Mac, and Windows wheels on AppVeyor, create an `appveyor.yml` file in your repo. @@ -281,7 +283,7 @@ AppVeyor will store the built wheels for you - you can access them from the proj For more info on this config file, check out the [docs](https://www.appveyor.com/docs/). -## CircleCI [linux/mac] {: #circleci} +### CircleCI [linux/mac] {: #circleci} To build Linux and Mac wheels on CircleCI, create a `.circleci/config.yml` file in your repo, @@ -298,7 +300,7 @@ Commit this file, enable building of your repo on CircleCI, and push. CircleCI will store the built wheels for you - you can access them from the project console. Check out the CircleCI [docs](https://circleci.com/docs/2.0/configuration-reference/#section=configuration) for more info on this config file. -## Gitlab CI [linux] {: #gitlab-ci} +### Gitlab CI [linux] {: #gitlab-ci} To build Linux wheels on Gitlab CI, create a `.gitlab-ci.yml` file in your repo, @@ -314,13 +316,13 @@ Gitlab will store the built wheels for you - you can access them from the Pipeli > ⚠️ Got an error? Check the [FAQ](faq.md). -# Next steps +## Next steps Once you've got the wheel building successfully, you might want to set up [testing](options.md#test-command) or [automatic releases to PyPI](deliver-to-pypi.md#automatic-method).