Joe RickerbyandHenry Schreiner
1d34f85c63
* Split the docs into sections * Split the options page into two pages - so the reference is more clean * Reorder/Tidy up this 'deliver' page to make auto-deploy more obvious * Fix up some links * Merge the platform docs into a single page to clean up the navbar. * Split the setup page to make a page dedicated to CI setup * Move general platform-specific information into the platforms page * Tidy up the platforms page * Remove some redundancy in the cpp/platforms docs * Clarify this section * Move another FAQ entry to the platforms page * Remove some out-of-date entries from the FAQ * A few corrections to the options page * Fix some broken links * Improve the Docker references * Update bump version filename * Improve options TOC information density * whitespace Co-authored-by: Henry Schreiner <HenrySchreinerIII@gmail.com> * Convert the normal test invocation to `pytest ./tests`, not placeholder --------- Co-authored-by: Henry Schreiner <HenrySchreinerIII@gmail.com>
60 lines
1.1 KiB
YAML
60 lines
1.1 KiB
YAML
site_name: cibuildwheel
|
|
docs_dir: docs
|
|
theme:
|
|
name: readthedocs
|
|
highlightjs: true
|
|
hljs_languages:
|
|
- yaml
|
|
collapse_navigation: false
|
|
navigation_depth: 3
|
|
custom_dir: docs/theme_overrides
|
|
repo_url: https://github.com/pypa/cibuildwheel
|
|
edit_uri: edit/main/docs/
|
|
|
|
extra_css:
|
|
- extra.css
|
|
|
|
extra_javascript:
|
|
- extra.js
|
|
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Guide:
|
|
- setup.md
|
|
- ci-services.md
|
|
- deliver-to-pypi.md
|
|
- faq.md
|
|
- cpp_standards.md
|
|
- Reference:
|
|
- platforms.md
|
|
- configuration.md
|
|
- options.md
|
|
- working-examples.md
|
|
- About:
|
|
- contributing.md
|
|
- changelog.md
|
|
|
|
markdown_extensions:
|
|
- md_in_html
|
|
- toc:
|
|
permalink: True
|
|
- attr_list
|
|
- admonition
|
|
- pymdownx.magiclink:
|
|
repo_url_shortener: True
|
|
- pymdownx.highlight:
|
|
# use highlightjs - it's built-in to the theme
|
|
use_pygments: False
|
|
- pymdownx.superfences
|
|
|
|
plugins:
|
|
- include-markdown
|
|
- search
|
|
- macros:
|
|
module_name: docs/main
|
|
j2_variable_start_string: «
|
|
j2_variable_end_string: »
|
|
on_error_fail: true
|
|
on_undefined: strict
|