-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Docs: fix broken and outdated documentation links #13706
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.
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
base: main
Are you sure you want to change the base?
Docs: fix broken and outdated documentation links #13706
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR fixes broken and outdated external documentation links as part of an HTTPS link audit. While the PR successfully updates some PyPI URLs to use HTTPS and fixes link formatting, there are issues with two changes where example URLs were completely removed, leaving incomplete documentation.
Key Changes
- Updated PyPI URLs from HTTP to HTTPS protocol in NEWS.rst and overview.rst
- Removed example.com URLs from user guide documentation (incomplete - needs proper replacement)
- Fixed malformed reStructuredText link syntax in architecture documentation
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/html/user_guide.rst | Attempts to remove outdated example.com URLs but leaves incomplete sentence fragments without proper URL examples |
| docs/html/development/architecture/overview.rst | Updates PyPI Simple API link to HTTPS and fixes RST syntax, though link text still shows HTTP protocol |
| NEWS.rst | Successfully updates historical PyPI mirrors link from HTTP to HTTPS |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/html/user_guide.rst
Outdated
| Requirements files can also be served via a URL, e.g. | ||
| requirements.txt besides as local files, so that they can | ||
| be stored and served in a centralized place. |
Copilot
AI
Dec 16, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The example in this line is incomplete. After removing the example URL, the text now reads "e.g. requirements.txt" which is not a valid URL example. Consider using a placeholder URL like "https://example.com/requirements.txt" instead, or rephrase the sentence to make it clear that any URL can be used without providing a specific example.
| Requirements files can also be served via a URL, e.g. | |
| requirements.txt besides as local files, so that they can | |
| be stored and served in a centralized place. | |
| Requirements files can also be served via a URL (for example, https://example.com/requirements.txt), in addition to being used as local files. This allows them | |
| to be stored and served in a centralized place. |
docs/html/user_guide.rst
Outdated
|
|
||
| Same as requirements files, constraints files can also be served via a URL, | ||
| e.g. http://example.com/constraints.txt, so that your organization can store and | ||
| e.g. constraints.txt, so that your organization can store and |
Copilot
AI
Dec 16, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The example in this line is incomplete. After removing the example URL, the text now reads "e.g. constraints.txt" which is not a valid URL example. Consider using a placeholder URL like "https://example.com/constraints.txt" instead, or rephrase the sentence to make it clear that any URL can be used without providing a specific example.
| e.g. constraints.txt, so that your organization can store and | |
| e.g. https://example.com/constraints.txt, so that your organization can store and |
|
|
||
| 1. Following the API defined in :pep:`503`, fetch the index page from | ||
| `http://{pypi_index}/simple/{package_name <http://pypi.org/simple/%7Bpackage_name>`__} | ||
| `http://{pypi_index}/simple/{package_name} <https://pypi.org/simple/{package_name}>`_ |
Copilot
AI
Dec 16, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link text shows "http://{pypi_index}/simple/{package_name}" but the actual URL uses HTTPS. For consistency and to avoid confusion, the link text should also use "https://" to match the actual URL protocol being linked to.
| `http://{pypi_index}/simple/{package_name} <https://pypi.org/simple/{package_name}>`_ | |
| `https://{pypi_index}/simple/{package_name} <https://pypi.org/simple/{package_name}>`_ |
docs/html/user_guide.rst
Outdated
|
|
||
| Requirements files can also be served via a URL, e.g. | ||
| http://example.com/requirements.txt besides as local files, so that they can | ||
| Requirements files can also be served via a URL, e.g. |
Copilot
AI
Dec 16, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is trailing whitespace at the end of this line that should be removed.
| Requirements files can also be served via a URL, e.g. | |
| Requirements files can also be served via a URL, e.g. |
491ba42 to
955813e
Compare
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
|
You shouldn't remove example URLs, they were never intended to work. If there is a better way to display them as an example that's fine, but they need to remain URLs. |
|
Got it — thanks for the clarification. I’ve restored the example URLs and marked them as literals so they remain examples without triggering link checks. |
This PR fixes several broken and outdated external links in the documentation,
identified during the HTTPS link audit.
This is a documentation-only change, so no news fragment is required.
Fixes part of #13664.