From b84dd90062bb5736ca4484c1486f6bb44b8011ef Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Fri, 29 May 2026 13:22:53 -0400 Subject: [PATCH] docs: support intersphinx (#2871) * Initial plan * Add mkdocs-intersphinx plugin to generate objects.inv for intersphinx linking Co-authored-by: henryiii <4616906+henryiii@users.noreply.github.com> * Add options.md comments to schema generator Co-authored-by: henryiii <4616906+henryiii@users.noreply.github.com> * Plan intersphinx marker fix Co-authored-by: henryiii <4616906+henryiii@users.noreply.github.com> * Add Python 3.12 marker to mkdocs-intersphinx Co-authored-by: henryiii <4616906+henryiii@users.noreply.github.com> * Revert schema comment metadata changes Co-authored-by: henryiii <4616906+henryiii@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Henry Schreiner * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: henryiii <4616906+henryiii@users.noreply.github.com> Co-authored-by: Henry Schreiner Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- docs/changelog.md | 1 + docs/ci-services.md | 1 + docs/configuration.md | 5 +++++ docs/contributing.md | 1 + docs/cpp_standards.md | 1 + docs/deliver-to-pypi.md | 1 + docs/faq.md | 1 + docs/index.md | 1 + docs/options.md | 5 +++++ docs/platforms.md | 1 + docs/setup.md | 1 + docs/working-examples.md | 1 + mkdocs.yml | 2 ++ pyproject.toml | 1 + 14 files changed, 23 insertions(+) diff --git a/docs/changelog.md b/docs/changelog.md index 58c6fb2f..f47f5ca5 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,5 +1,6 @@ --- title: Changelog +ref: changelog --- # Changelog diff --git a/docs/ci-services.md b/docs/ci-services.md index 864bba36..6c2c99df 100644 --- a/docs/ci-services.md +++ b/docs/ci-services.md @@ -1,5 +1,6 @@ --- title: Configuring a CI service +ref: ci-services --- ## Configuring a CI service diff --git a/docs/configuration.md b/docs/configuration.md index ae05b420..a1085df6 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,3 +1,8 @@ +--- +title: Configuration +ref: configuration +--- + # Configuration methods cibuildwheel can either be configured using environment variables, or from diff --git a/docs/contributing.md b/docs/contributing.md index f5693cf2..cdc9bb1f 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,5 +1,6 @@ --- title: Contributing +ref: contributing --- # Contributing diff --git a/docs/cpp_standards.md b/docs/cpp_standards.md index b22b2ff7..08ff5497 100644 --- a/docs/cpp_standards.md +++ b/docs/cpp_standards.md @@ -1,5 +1,6 @@ --- title: Modern C++ standards +ref: cpp-standards --- # Modern C++ standards diff --git a/docs/deliver-to-pypi.md b/docs/deliver-to-pypi.md index 1fecec31..a7d5ca07 100644 --- a/docs/deliver-to-pypi.md +++ b/docs/deliver-to-pypi.md @@ -1,5 +1,6 @@ --- title: Delivering to PyPI +ref: deliver-to-pypi --- # Delivering to PyPI diff --git a/docs/faq.md b/docs/faq.md index adb47d31..c8a12b01 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,5 +1,6 @@ --- title: Tips and tricks +ref: faq --- # Tips and tricks diff --git a/docs/index.md b/docs/index.md index ac4a89ae..14cd6e5d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,6 @@ --- title: Home +ref: index --- # cibuildwheel diff --git a/docs/options.md b/docs/options.md index 6ace324b..d53f33bf 100644 --- a/docs/options.md +++ b/docs/options.md @@ -1,3 +1,8 @@ +--- +title: Options +ref: options +--- + # Options
diff --git a/docs/platforms.md b/docs/platforms.md index 89e17908..ee2f8843 100644 --- a/docs/platforms.md +++ b/docs/platforms.md @@ -1,5 +1,6 @@ --- title: Platforms +ref: platforms --- # Platforms diff --git a/docs/setup.md b/docs/setup.md index 412acdf0..2af873cf 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,5 +1,6 @@ --- title: 'Getting started' +ref: setup --- # Getting started diff --git a/docs/working-examples.md b/docs/working-examples.md index 66f4265a..245bf06e 100644 --- a/docs/working-examples.md +++ b/docs/working-examples.md @@ -1,5 +1,6 @@ --- title: Working examples +ref: working-examples --- diff --git a/mkdocs.yml b/mkdocs.yml index f68d2c8d..95115b0c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -58,3 +58,5 @@ plugins: j2_variable_end_string: ยป on_error_fail: true on_undefined: strict + - intersphinx: + project: cibuildwheel diff --git a/pyproject.toml b/pyproject.toml index 99aac2e2..1d0d1e62 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -66,6 +66,7 @@ Homepage = "https://github.com/pypa/cibuildwheel" docs = [ "jinja2>=3.1.2", "mkdocs-include-markdown-plugin==7.1.8", + "mkdocs-intersphinx>=0.1.1; python_version >= '3.12'", "mkdocs-macros-plugin>=1.4.1", "mkdocs==1.6.1", "pymdown-extensions",