Skip to content
Snippets Groups Projects
Commit 488ce42f authored by Joseph Weston's avatar Joseph Weston
Browse files

Merge branch 'fix/linkcheck-specificity' into 'stable'

Incraese the timeout and number of retries when running the
link check on the documentation; this should increase the
specificity of the test.

See merge request kwant/kwant!332
Closes #332.
parents 6be96689 9101ec30
No related branches found
No related tags found
No related merge requests found
Pipeline #24226 passed
......@@ -270,8 +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'),
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment