Fix linkcheck - #1484
Merged
Merged
Conversation
webknjaz
reviewed
Jan 14, 2024
webknjaz
left a comment
Member
There was a problem hiding this comment.
Is it possible to disable checking anchors instead?
Contributor
|
Try # conf.py
linkcheck_anchors_ignore_for_url = [
r"^https://github\.com/[^#]+#.+",
]This will ignore anchors for all GitHub links |
Apparently, GitHub now adds the README HTML on a project page dynamically through JS, which prevents Sphinx's link checker from finding anchors into the README.
Contributor
Author
|
Oh, I didn't know that option, thank you. |
chrysle
approved these changes
Jan 15, 2024
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
4 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.
Apparently, GitHub now adds the README HTML on a project page dynamically through JS, which prevents Sphinx's link checker from finding anchors into the README.
📚 Documentation preview 📚: https://python-packaging-user-guide--1484.org.readthedocs.build/en/1484/