Fixed #32720 -- Added configuration and docs for Sphinx link checker. #14325
Conversation
This file contains 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
ngnpope
changed the title
felixxm
changed the title
ngnpope
commented
May 17, 2021
We explicitly ignore checking anchors for line-range anchors on GitHub which are dynamically generated and, otherwise, show up as broken links. See sphinx-doc/sphinx#7388 (comment). We also ignore links to resources that require authentication.
ngnpope
added a commit
to ngnpope/drf-spectacular
that referenced
this pull request
Apr 20, 2022
Also updated links to canonical locations to reduce redirects.
These were discovered using `make linkcheck`.
I did something similar a while back for Django:
django/django#14325
ngnpope
added a commit
to ngnpope/drf-spectacular
that referenced
this pull request
Apr 21, 2022
Also updated links to canonical locations to reduce redirects.
These were discovered using `make linkcheck`.
I did something similar a while back for Django:
django/django#14325
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.
ticket-32720
I've used the linkcheck builder in Sphinx to identify a number of broken links that I've fixed, and updated others to use the canonical link so that unnecessary redirects are avoided.
Ideally, the output generated in
docs/_build/linkcheck/output.{json,txt}would only contain "working" links, but there are some links that are better left redirecting, e.g. for documentation versions such ashttps://docs.djangoproject.com/en/stable/→https://docs.djangoproject.com/en/3.2/. There is an open issue for adding a configuration setting to allow certain redirects to be treated as "normal". See sphinx-doc/sphinx#6525 (comment).Questions:
docs/internals/contributing/writing-documentation.txtabout using the linkcheck builder?docs/internals/howto-release-django.txtabout checking before preparing a release?If Link checker should be able to prohibit unknown redirects sphinx-doc/sphinx#6525 is resolved, would this check be useful to add to a scheduled action in GitHub?