🔧 Update linkcheck configuration

trallard · trallard · commit 59456038ddfb · 2025-03-24T13:40:54.000Z
diff --git a/docs/conf.py b/docs/conf.py
@@ -358,6 +358,8 @@ def setup(app: Sphinx) -> Dict[str, Any]:
     }
 
 
+# -- linkcheck options ---------------------------------------------------------
+
 linkcheck_anchors_ignore = [
     # match any anchor that starts with a '/' since this is an invalid HTML anchor
     r"\/.*",
@@ -399,3 +401,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
     r"http://www.yahoo.com": "https://www.yahoo.com/",
     r"https://feature-engine.readthedocs.io/": "https://feature-engine.trainindata.com/en/latest/",
 }
+
+# we have had issues with linkcheck timing and retries on www.gnu.org
+linkcheck_retries = 3
+linkcheck_timeout = 50

Original file line number	Diff line number	Diff line change
`@@ -358,6 +358,8 @@ def setup(app: Sphinx) -> Dict[str, Any]:`
`358`	`358`	`}`
`359`	`359`
`360`	`360`
	`361`	`+# -- linkcheck options ---------------------------------------------------------`
	`362`	`+`
`361`	`363`	`linkcheck_anchors_ignore = [`
`362`	`364`	`# match any anchor that starts with a '/' since this is an invalid HTML anchor`
`363`	`365`	`r"\/.*",`
`@@ -399,3 +401,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:`
`399`	`401`	`r"http://www.yahoo.com": "https://www.yahoo.com/",`
`400`	`402`	`r"https://feature-engine.readthedocs.io/": "https://feature-engine.trainindata.com/en/latest/",`
`401`	`403`	`}`
	`404`	`+`
	`405`	`+# we have had issues with linkcheck timing and retries on www.gnu.org`
	`406`	`+linkcheck_retries = 3`
	`407`	`+linkcheck_timeout = 50`