Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ignore PyPI anchors when checking links #1767

Merged
merged 1 commit into from
Dec 23, 2024
+5 −3
Merged

Ignore PyPI anchors when checking links #1767

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,13 @@
"https://anaconda.org",
]
linkcheck_retries = 5
# Ignore anchors for links to GitHub project pages -- GitHub adds anchors from
# README.md headings through JavaScript, so Sphinx's linkcheck can't find them
# in the HTML.
# Ignore anchors for common targets when we know they likely won't be found
linkcheck_anchors_ignore_for_url = [
# GitHub synthesises anchors in JavaScript, so Sphinx can't find them in the HTML
r"https://github\.com/",
# While PyPI has its botscraping defenses active, Sphinx can't resolve the anchors
# https://github.com/pypa/packaging.python.org/issues/1744
r"https://pypi\.org/",
]

# -- Options for extlinks ----------------------------------------------------------
Expand Down
Loading