Skip to content

gh-93851: Fix all broken links in Doc/ #93853

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

Merged
ambv merged 11 commits into from
Jun 21, 2022
Merged

gh-93851: Fix all broken links in Doc/ #93853

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d34731f
Fix all broken links in Doc/
arhadthedev Jun 15, 2022
9a20620
Fix line ends
arhadthedev Jun 15, 2022
bd5d3d2
Add a living link to setuptool entry points
arhadthedev Jun 15, 2022
c8fa76e
Return lists.idyll.org link back
arhadthedev Jun 15, 2022
e895a5f
Address Ned's review
arhadthedev Jun 16, 2022
877513b
Copy a comment by Ned into the code
arhadthedev Jun 16, 2022
17aa611
Use tags instead of commit hashes
arhadthedev Jun 16, 2022
6cdf99a
Fix a typo
arhadthedev Jun 16, 2022
73ae702
Use Jinja comments instead of the Liquid ones
arhadthedev Jun 16, 2022
9f6ced4
Merge branch 'main' into fix-doc-links
arhadthedev Jun 16, 2022
8665a44
Use HTTPS for Web Archive links
arhadthedev Jun 17, 2022
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
Prev Previous commit
Next Next commit
Use tags instead of commit hashes
  • Loading branch information
@arhadthedev
arhadthedev committed Jun 16, 2022
commit 17aa6113468fa702b1d56acebad84ac0ebe0ba1c
6 changes: 3 additions & 3 deletions Doc/whatsnew/3.2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2593,11 +2593,11 @@ Changes to Python's build process and to the C API include:
longer used and it had never been documented (:issue:`8837`).

There were a number of other small changes to the C-API. See the
Misc/NEWS <https://github.com/python/cpython/blob/076ca6c3c8df3030307e548d9be792ce3c1c6eea/Misc/NEWS>`_
file for a complete list.
Misc/NEWS <https://github.com/python/cpython/blob/v3.2.6/Misc/NEWS>`_
Copy link
Copy Markdown
Member Author

@arhadthedev arhadthedev Jun 21, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Misc/NEWS <https://github.com/python/cpython/blob/v3.2.6/Misc/NEWS>`_
`Misc/NEWS <https://github.com/python/cpython/blob/v3.2.6/Misc/NEWS>`_

For some reason, gh-94078 backport is the only one that caught this typo.

Copy link
Copy Markdown
Member

@CAM-Gerlach CAM-Gerlach Oct 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possibly because it was using the old docs checker script as opposed to Sphinx-Lint. Could you verify whether the latest Sphinx-Lint 0.6.6 catches this case, and if not, could you report it upstream? Thanks!

Copy link
Copy Markdown
Member

@CAM-Gerlach CAM-Gerlach Oct 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, it really isn't great that we're regressing from using a dedicated role to hardcoded links...but hopefully the new suite of roles we're developing for this will replace this.

Copy link
Copy Markdown
Member Author

@arhadthedev arhadthedev Oct 29, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you verify whether the latest Sphinx-Lint 0.6.6 catches this case [...]

I ran sphinx-lint 0.6.7 and it caught the typo successfully:

C:\Users\oleg\Documents\dev\notmine\cpython>sphinx-lint Doc/whatsnew/3.2.rst
Doc/whatsnew/3.2.rst:54: missing backtick before hyperlink reference: 'Misc/NEWS <https://github.com/python/cpython/blob/v3.2.6/Misc/NEWS>`_'. (hyperlink-reference-missing-backtick)

So I hope that adoption of sphinx-lint will eliminate such sporadic discoveries.

\file for a complete list.

Also, there were a number of updates to the Mac OS X build, see
`Mac/BuildScript/README.txt <https://github.com/python/cpython/blob/b02f7c00aecf2b418dbf4c7762c3fa268163a900/Mac/BuildScript/README.txt>`_
`Mac/BuildScript/README.txt <https://github.com/python/cpython/blob/v3.2.6/Mac/BuildScript/README.txt>`_
for details. For users running a 32/64-bit
build, there is a known problem with the default Tcl/Tk on Mac OS X 10.6.
Accordingly, we recommend installing an updated alternative such as
Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/3.6.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2118,7 +2118,7 @@ API and Feature Removals
date, inconsistently available across platforms, and unmaintained. The
script that created these modules is still available in the source
distribution at `Tools/scripts/h2py.py
<https://github.com/python/cpython/blob/20737cc91e823b6b17fff16574283c034c99d641/Tools/scripts/h2py.py>`_.
<https://github.com/python/cpython/blob/v3.6.15/Tools/scripts/h2py.py>`_.

* The deprecated ``asynchat.fifo`` class has been removed.

Expand Down
4 changes: 2 additions & 2 deletions Doc/whatsnew/3.7.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2121,8 +2121,8 @@ Platform Support Removals
1.0.2 or later, and remain supported in the default build configuration.

CPython's own `CI configuration file
<https://github.com/python/cpython/blob/5fe7c98a54d127759cfce323fab831008c945964/.travis.yml>`_
provides an example of using the SSL
<https://github.com/python/cpython/blob/v3.7.13/.travis.yml>`_ provides an
example of using the SSL
:source:`compatibility testing infrastructure <Tools/ssl/multissltests.py>` in
CPython's test suite to build and link against OpenSSL 1.1.0 rather than an
outdated system provided OpenSSL.
Expand Down