Skip to content
Prev Previous commit
Next Next commit
config changes
  • Loading branch information
jameslamb committed Jul 12, 2025
commit cae36edfcb5ed5f4d018f04b4c01c6e5e00ecb41
6 changes: 3 additions & 3 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -208,15 +208,15 @@

# -- Options for linkcheck -------------------------------------------------

# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-linkcheck_anchors_ignore_for_url
# config reference: https://www.sphinx-doc.org/en/master/usage/configuration.html
linkcheck_anchors_ignore_for_url = [
# GitHub code links with line-number anchors are reported as "not found"
r"https://github\\.com/.*#L[0-9]+[0-9L\\-]+",
r"https:\/\/.*github\.com.*\/blob\/.*",
]

linkcheck_ignore = [
# gnu.org is so strictly rate-limited that retries to it really slow down link-checking... just assume they're fine
r".*gnu\\.org.*",
r"https:\/\/.*gnu\.org.*",
]

def _post_build(app: "Sphinx", exception: Exception | None) -> None:
Expand Down
2 changes: 1 addition & 1 deletion noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def docs(session):
@nox.session(name="docs-linkcheck")
def docs_linkcheck(session):
"""
Check that links are valid (well-formed and point to something that exists).
Check that links are well-formed and point to something that exists.
"""
session.install("-e", ".")
session.run(
Expand Down