Skip to content

Commit 2da9bb7

Browse files
committed
Configure Sphinx to ignore GitHub comment anchors
Add linkcheck_anchors_ignore setting to skip GitHub's dynamic comment anchors during documentation link validation. This prevents false positives in CI when checking links to GitHub issue comments, as GitHub injects these anchors dynamically in the web interface.
1 parent b02c9a0 commit 2da9bb7

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@
3939
html_split_index = False
4040
html_short_title = f'{project}-{version}'
4141

42+
linkcheck_anchors_ignore = ['^issuecomment-']
43+
4244
napoleon_use_ivar = True
4345
napoleon_use_rtype = False
4446
napoleon_use_param = False

0 commit comments

Comments
 (0)