From 5c8761f3b3bb387b658b4f77d42d25a17693a161 Mon Sep 17 00:00:00 2001 From: Joseph Weston Date: Fri, 15 Nov 2019 14:09:34 +0100 Subject: [PATCH 1/2] set the number of retries when running linkcheck to 5 Retrying > once should increase the specificity of the check a lot. --- doc/source/conf.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/source/conf.py b/doc/source/conf.py index 30cd3e5..5c1c3ca 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -272,6 +272,10 @@ def setup(app): # IOP times out on check but the link verified and correct. linkcheck_ignore = [r'https://iopscience.iop.org/1367-2630/16/6/063065/article'] +# By default linkcheck only tries once, but experience has shown us that this test is +# very non-specific for detecting dead links. Trying a few times should significantly +# lower the probability of false positives. +linkcheck_retries = 5 nitpick_ignore = [('py:class', 'Warning'), ('py:class', 'Exception'), ('py:class', 'object'), ('py:class', 'tuple'), -- GitLab From 9101ec3086460b28178bdb6ae955a134eada3471 Mon Sep 17 00:00:00 2001 From: Joseph Weston Date: Fri, 15 Nov 2019 14:13:53 +0100 Subject: [PATCH 2/2] add longer timeout for linkcheck and remove specific linkcheck ignore The combination of longer timeout and larger number of retries should make the linkcheck sufficiently specific again. --- doc/source/conf.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 5c1c3ca..f942ab5 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -270,12 +270,13 @@ def setup(app): app.add_autodocumenter(BoundMethodDocumenter) -# IOP times out on check but the link verified and correct. -linkcheck_ignore = [r'https://iopscience.iop.org/1367-2630/16/6/063065/article'] # By default linkcheck only tries once, but experience has shown us that this test is # very non-specific for detecting dead links. Trying a few times should significantly # lower the probability of false positives. linkcheck_retries = 5 +# Some websites (particularly IoP) take a long time to respond. The combination of +# this timeout and the retries should make this check sufficiently specific. +linkcheck_timeout = 10 nitpick_ignore = [('py:class', 'Warning'), ('py:class', 'Exception'), ('py:class', 'object'), ('py:class', 'tuple'), -- GitLab