Add smarter defaults for linkcheck.

This includes a default of 3 retires on failure and then makes the timeout option more visible within the config file. These are based on a fixing change to MicroOVN where we were having instability in linkchecks. Signed-off-by: MJ Ponsonby <[email protected]>
canonical · Dec 12, 2024 · a5936e3 · a5936e3
1 parent 2866c4d
commit a5936e3
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -195,6 +195,9 @@
 
 linkcheck_anchors_ignore_for_url = [r"https://github\.com/.*"]
 
+# give linkcheck multiple tries on failure
+# linkcheck_timeout = 30
+linkcheck_retries = 3
 
 ########################
 # Configuration extras #