docs: exclude 16 recurring broken Lightning doc links from linkcheck - #16222
Open
VaggelisGian wants to merge 1 commit into
Open
docs: exclude 16 recurring broken Lightning doc links from linkcheck#16222VaggelisGian wants to merge 1 commit into
VaggelisGian wants to merge 1 commit into
Conversation
The release docs linkcheck fails on 16 external PyTorch Lightning URLs whose anchors no longer resolve: the lightning.ai optional-api pages serve their content without the anchor ids that its own intersphinx inventory advertises, and the readthedocs.io mirrors carry stale anchors. The pages themselves load, so the links are useful to readers but unverifiable by the checker. Add all 16 entries to broken_links_false_positives.json, following the existing entries for anchor-not-found cases. Also rename broken_links_needing_review..json to broken_links_needing_review.json: the CI linkcheck step only reads the single-dot filename, so the two entries in the double-dot file were never applied. Signed-off-by: Vaggelis <baggelis100@gmail.com>
svcnvidia-nemo-ci
added
the
waiting-on-maintainers
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
2 participants
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.
What does this PR do ?
Makes the release docs linkcheck pass again by excluding 16 external PyTorch Lightning URLs whose anchors no longer resolve, and fixes the filename of the needs-review exclusion list so its entries actually apply.
Background: the
release / finalize / build-docs / Build docsjob has been failing on the same 16 links on many PRs. The lightning.ai optional-api pages return HTTP 200 but do not contain the anchor ids that Lightning's own intersphinx inventory advertises (the pages are verified live), and the readthedocs.io mirrors carry stale anchors after the docs restructure. The pages load fine for readers, so the links stay in the docs and the entries are recorded as checker false positives, matching the existing anchor-not-found entries in the same file.This change was first proposed inside #16132 and reverted there per review, reworked here as the standalone contribution it was offered to be.
Collection: common (documentation)
Changelog
docs/source/broken_links_false_positives.json.docs/source/broken_links_needing_review..jsontobroken_links_needing_review.json. The CI linkcheck step only reads the single-dot filename, so the two entries in the double-dot file were never applied.Usage
No user-facing behavior change. After this lands, the
Build docsjob stops failing on these 16 links, andrelease-summary(which counts failed jobs) stops failing with it.GitHub Actions CI
For an untrusted PR, a maintainer can trigger CI by commenting
/ok to test <head-sha>.Before your PR is "Ready for review"
Pre checks:
Checks run locally: JSON stream validation of both exclusion files (46 false-positive entries, 2 needing-review entries), and confirmation that all 16 URIs from the failing CI run are covered by the lists. Commits carry DCO sign-off.