Skip to content

Commit f249fb8

Browse files
committed
docs(linkcheck): bound external requests to 15 seconds
One hanging external server blocked its linkcheck worker forever and ran the CI docs-linkcheck job into its 10-minute kill, ending the job as cancelled (which continue-on-error cannot absorb) instead of failed (which it can). Seen on three of the last four develop runs, including one that predates today's README work.
1 parent 7e49444 commit f249fb8

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

docs/conf.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -384,3 +384,13 @@
384384
intersphinx_mapping: dict[str, tuple[str, None]] = {
385385
'python': ('https://docs.python.org/3', None)
386386
}
387+
388+
# -- Options for linkcheck ------------------------------------------------
389+
390+
# Without a timeout, one hanging external server blocks its linkcheck
391+
# worker forever and runs the CI docs-linkcheck job into its 10-minute
392+
# kill, where it ends up cancelled instead of failed. A bounded timeout
393+
# turns the hang into an ordinary broken-link failure, which the
394+
# workflow's continue-on-error for experimental envs can absorb.
395+
linkcheck_timeout = 15
396+
linkcheck_retries = 2

0 commit comments

Comments
 (0)