Repository navigation
Check the built docs for broken internal links - #2975
Merged
Merged
Conversation
Sphinx's nitpicky mode catches broken cross-references, but not plain links such as a figure's :target: or a named link missing its trailing underscore. util/check_internal_links.py scans the HTML Sphinx wrote for links to pages, files or anchors that don't exist, and make.py docs-full, which CI runs, now runs it after the build. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
Closes #1168. Part 2, after #2974 fixed the existing broken links.
uv run make.py docs-full, which CI's docs job runs, now runsutil/check_internal_links.py buildafter the Sphinx build. It fails the build if any page links to a page, file or anchor that doesn't exist.Why
Since #2970, nitpicky mode catches broken cross-references (
:ref:,:py:class:and so on). It doesn't see plain links, which is how these got through:`Discord <Arcade Discord>`_, fixed in Fix broken links in the docs #2974. docutils silently treats the name as a relative URL.The script checks the HTML Sphinx actually wrote, so it catches any of these, whatever the source.
How it works
_modules/,_static/,_sources/,genindexandsearchpages.href/src, it checks that the target file exists. For#anchorlinks to an HTML page, it checks that the page has thatid.http,https,mailto,data) and cache-busting query strings (?v=...).os.path.normpath, notPath.resolve().resolve()hung on some links on Windows.import systomake.py, which the new line needs.Per #1168's discussion, this doesn't check external links. Those go down unpredictably, so
make.py linkcheckstays a manual command.Tested
uv run make.py docs-fullfrom a cleanbuild/passes. The Sphinx build plus the check report "No broken internal links".run()inmake.pyexits with a failing command's status, sodocs-fullfails too.🤖 Generated with Claude Code