Repository navigation
Fix broken links in the docs - #2974
Merged
Merged
Conversation
- 19 named links like `Discord <Arcade Discord>`_ were missing the trailing underscore that makes the name a reference, so docutils linked to pages called "Arcade Discord" etc. The Swedish and German textbook links also had no targets. - Two "How to Get Help" links pointed at section labels as URLs. - A malformed CONTRIBUTING.md link in PymunkPhysicsEngine's docstring. - The resources page used absolute /_static/ paths, which only worked on Read the Docs, where the site URL was prefixed. They're relative now. - Six dead external links: the CPython GC docs moved, a quaternion article is gone (archived copy), the Nuitka tutorial pointed at 17_views.py (now 20_views.py), pyglet's master docs, a renamed Kenney asset page, and a community game whose repo no longer exists. 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
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.
Part 1 of #1168. The next PR adds a CI check for internal links.
I scanned every page of a built copy of the docs for links to files or anchors that don't exist, and ran Sphinx's
linkcheckfor external links. This fixes everything both found, except external sites that refuse automated requests.Internal links: 43 broken → 0
`Discord <Arcade Discord>`_. Without the underscore inside the brackets, docutils treats the name as a relative URL and links to a page calledArcade Discord. Nitpicky mode can't catch this, because it isn't a cross-reference. They were on the academia, licensing, contributing and Raspberry Pi pages, and in the video section of the resources page.learn.arcade.academy/sv/latest/and/de/latest/) after checking the pages are the translated books.:ref:now. One also had the wrong label name.PymunkPhysicsEngine's docstring:<CONTRIBUTING.md: https://...>./_static/...paths.src_kludge()prefixed them with the Read the Docs URL, so they worked there, but they broke in any other build. They're relative to the page now (../_static/...), which works everywhere. Fullhttps://URLs, used for the audio files, are left alone.Dead external links (404)
devguide.python.org/internals/garbage-collector/InternalDocs/garbage_collector.mdarcade.mathquaternion docstringplatform_tutorial/17_views.py20_views.py, the same step after renumbering (10 mentions)Window.set_mouse_cursordocstringen/masterdocsen/development(pyglet 3)kenney.nl/assets/toon-characters-1kenney.nl/assets/toon-charactersgithub.com/thecodeah/space-typerNot changed: links that return 403 to automated requests (StackOverflow, SuperUser, Shadertoy, the Khronos wiki, ISO) and easings.net anchors, which are built by JavaScript. They work in a browser.
Checked
-W(nitpicky) passes.🤖 Generated with Claude Code