[PATCH 1/8] conf.py: add linkcheck builder exclusions
Antonin Godard <[email protected]> Fri, 10 Jul 2026 16:46:48 +0200
| Newsgroups | org.yoctoproject.lists.docs |
|---|---|
| Message-ID | <[email protected]> |
The linkcheck builder can be used to scout for broken links. By looking at the output of: grep -E -r --no-filename -o 'href="http.://[^/"]+' | sort | uniq -c | sort -nr from the HTML output directory, exclude links that are too frequent. Also remove docs.yoctoproject.org links are those should already be validated when building the documentation. Signed-off-by: Antonin Godard <[email protected]> --- documentation/conf.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/documentation/conf.py b/documentation/conf.py index 7b201ebd6..aff01c1ed 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -143,6 +143,19 @@ suppress_warnings = ['epub.unknown_project_files'] # sphinx-copybutton configuration copybutton_prompt_text = "$ " +# When using the linkcheck builder, ignore the following links which are too +# present in the docs, and self-references to yocto-docs which are already +# checked. +linkcheck_ignore = [ + r'https?://nvd\.nist\.gov.*', + r'https?://docs\.yoctoproject\.org.*', + r'https?://git\.yoctoproject\.org.*', + r'https?://git\.openembedded\.org.*', + r'https?://downloads\.yoctoproject\.org.*', + r'https?://mirrors\.kernel\.org.*', + r'https?://mirrors\.edge\.kernel\.org.*' +] + # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for -- 2.54.0