Fix broken build:installation cross-reference failing the docs build#5245
Open
HarperZ9 wants to merge 1 commit into
Open
Fix broken build:installation cross-reference failing the docs build#5245HarperZ9 wants to merge 1 commit into
HarperZ9 wants to merge 1 commit into
Conversation
The Quick Start guide links to build's installation page via the
``build:installation`` intersphinx target, but build restructured its
docs and that document is now ``how-to/install`` (the old
``installation`` page returns 404; ``how-to/install`` exists). Because
the docs build runs Sphinx with warnings treated as errors, this fails
the `collateral (docs)` job on main:
docs/userguide/quickstart.rst:22: WARNING: unknown document:
'build:installation' [ref.doc]
build finished with problems, 1 warning (with warnings treated as errors).
Point the cross-reference at ``build:how-to/install``.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
Tick the box to add this pull request to the merge queue (same as
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The
collateral (docs)job fails onmain. The Quick Start guide cross-references :pypi:build's installation page through thebuild:installationintersphinx target, butbuildrestructured its documentation and that page no longer exists, so Sphinx (run with warnings-as-errors) fails:Verification of the new target
https://build.pypa.io/en/stable/installation.html-> 404https://build.pypa.io/en/stable/how-to/install.html-> exists (titled "Installation")So the document moved from
installationtohow-to/install.Change
One line in
docs/userguide/quickstart.rst:This resolves the only
ref.docwarning in the docs build. Anewsfragments/entry is included.Note: the same CI run also shows unrelated failures (a cygwin/
GitHub rawnetwork flake and a couple of test jobs) that this docs-only change does not touch.Disclosure: authored with AI assistance (Claude), reviewed and verified before submitting.