Skip to content

Commit

Permalink
Update linkcheck_ignore setting for docs
Browse files Browse the repository at this point in the history
The project management pages on PyPI fail the check today

Also fix two of the links that are currently broken on the packaging
guide.
  • Loading branch information
sigmavirus24 committed Feb 11, 2024
1 parent ab0ed19 commit 09d993a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
Changelog
=========

This project follows the `semantic versioning <https://packaging.python.org/guides/distributing-packages-using-setuptools/#semantic-versioning-preferred>`_
and `pre-release versioning <https://packaging.python.org/guides/distributing-packages-using-setuptools/#pre-release-versioning>`_
This project follows the `semantic versioning <https://packaging.python.org/en/latest/discussions/versioning/#semantic-versioning-vs-calendar-versioning>`_
and `pre-release versioning <https://packaging.python.org/en/latest/discussions/versioning/>`_
schemes recommended by the Python Packaging Authority.

.. Do *NOT* add changelog entries here!
Expand Down
12 changes: 8 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -265,15 +265,19 @@
# How to display URL addresses: 'footnote', 'no', or 'inline'.
# texinfo_show_urls = 'footnote'

# See https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-linkcheck_ignore
linkcheck_ignore = [
"http://127.0.0.1*",
r"https?://127\.0\.0\.1.*",
# Avoid errors due to GitHub rate limit
# https://github.com/sphinx-doc/sphinx/issues/7388
"https://github.com/pypa/twine/issues/*",
r"https://github\.com/pypa/twine/issues/.*",
# Avoid errors from channels interpreted as anchors
"https://web.libera.chat/#",
r"https://web\.libera\.chat/#",
# Avoid error from InvalidPyPIUploadURL docstring
"https://upload.pypi.org/legacy",
r"https://upload\.pypi\.org/legacy/?",
# Avoid errors from 403/Login Redirects
r"https://(test\.)?pypi\.org/manage/project/twine/collaboration/?",
r"https://pypi\.org/manage/project/twine/collaboration/?",
]

intersphinx_mapping = {
Expand Down

0 comments on commit 09d993a

Please sign in to comment.