Ignore anchor and local link #4487
Conversation
fujitatomoya
left a comment
fujitatomoya
left a comment
There was a problem hiding this comment.
although this is not perfect solution for #4209, it can exclude local links and anchors. that i think the improvement to take.
@ros2/team what do you think?
fujitatomoya
left a comment
fujitatomoya
left a comment
There was a problem hiding this comment.
lgtm with green CI
|
Cool! Thanks! |
conf.py
Outdated
| linkcheck_ignore = [ | ||
| r"^(?!http(|s):\/\/).*", # For ignore local link | ||
| ] | ||
| linkcheck_anchors = False |
There was a problem hiding this comment.
I'm wondering if we should use https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-linkcheck_anchors_ignore_for_url instead. In particular, I that will still check that the URL is valid, it just won't check that the anchor is valid.
There was a problem hiding this comment.
OK. So I would use linkcheck_anchors_ignore_for_url instead for
https://index.ros.orghttps://github.com
Thank you so much for the suggestions.
conf.py
Outdated
|
|
||
| # -- Options for linkcheck ------------------------------------------------ | ||
| linkcheck_ignore = [ | ||
| r"^(?!http(|s):\/\/).*", # For ignore local link |
There was a problem hiding this comment.
Can you explain exactly what we are skipping here? An example of a link that this is skipping would help.
There was a problem hiding this comment.
The local link which does not start from https:// or http:// are ignored here.
This is for the link like ../../humble/Installation.htm which refers to the different distro that didn't build with a particular branch but exists on the published document.
However, this way of implementation ignores all local links and possibly passes the real broken links like #4488.
So to prevent those cases, it is better to add local links one by one manually
linkcheck_ignore = [
r"../../(humble|galactic|etc..)/Installation.htm", # For ignore local linkIf you prefer the former, I will modify it accordingly.
4 participants
Features
Add linkcheck ignore settings
Related
#4209