Fix broken documentation links and add a linkcheck env#2134
Merged
Conversation
bboe
force-pushed
the
fix-broken-doc-links
branch
3 times, most recently
from
66febfb to
e58d68a
Compare
A Sphinx linkcheck surfaced dead links and stale redirects: - Fix three broken links: the PRAW 7 migration guide (pin to v7.8.2, which still serves the page) and the requests 'advanced usage' page (moved to /en/stable/). - Update stale redirects to their final URLs: the archived reddit/reddit repo and wikis (now reddit-archive/reddit and /r/reddit.com/wiki/), the Reddit Help support site, and the Python installation guide. Point bare requests/Async PRAW doc URLs at /en/stable/. - Add a 'linkcheck' tox env (kept out of the default envlist, since external links are flaky) and configure linkcheck to skip client-side GitHub anchors and the bot-blocking Reddit Help support site. Auth-walled (prefs/apps), short-link (redd.it), and historical changelog URLs are intentionally left as-is.
bboe
force-pushed
the
fix-broken-doc-links
branch
from
e58d68a to
f559244
Compare
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.
A Sphinx
linkcheckrun (never done before) surfaced three genuinely dead external links, now fixed:praw8_migration.rst) — the/en/v7.8.1/URL 404s (the page was dropped in 7.8.x builds); pinned to/en/v7.7.1/, which still serves it.configuration.rst, ×2) — moved from/en/main/to/en/latest/(the#proxiesand#ssl-cert-verificationanchors).Also adds a
linkchecktox env to catch future link rot. It's intentionally kept out of the default envlist because external links are flaky (e.g. the Reddit Help support site bot-blocks with 403s, and sites go down transiently) — it's a manual/periodic check, not a PR gate. Configuredlinkcheckto skip:After these changes
tox -e linkcheckreports zero broken links.