Skip to content

Commit 4c81a02

Browse files
committed
docs conf : Link check: Ignore link anchors
For all link anchors to work it requires page rendering of the given link which is not supported so disable this feature. e.g. github links with anchors will fail due to being implemented in js see also https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-linkcheck_anchors
1 parent 4951713 commit 4c81a02

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,11 @@
357357
gettext_compact = False # optional.
358358

359359

360+
# Link check: Ignore anchors as this requires page rendering of the link
361+
# e.g. github links with anchors will fail due to being implemented in js
362+
# see https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-linkcheck_anchors
363+
linkcheck_anchors = False
364+
360365

361366
def setup(app):
362367
app.add_config_value('recommonmark_config', {

0 commit comments

Comments
 (0)