Docs 8000 : add link roles with Sphinx extlinks #117850
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AlexWaygood
approved these changes
Apr 15, 2024
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
|
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12. |
|
Sorry, @hugovk, I could not cleanly backport this to |
hugovk
added a commit
to hugovk/cpython
that referenced
this pull request
Apr 15, 2024
(cherry picked from commit 3375282) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
|
GH-117910 is a backport of this pull request to the 3.12 branch. |
hugovk
added a commit
that referenced
this pull request
Apr 15, 2024
diegorusso
pushed a commit
to diegorusso/cpython
that referenced
this pull request
Apr 17, 2024
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
extlinksSphinx module (since Sphinx 1.0) allows us to easily create roles by defining a dict mapping toconf.py:We can use this to replace the custom
:source:role defined inDoc/tools/extension/pyspecific.pywith a single dict entry.It's also useful to add handy roles for CVEs, CWEs, and PyPI project links. If the URL scheme changes in the future (as has happened with PyPI, and others when going http->https) we can update all the links by only changing one line of config.
This PR also adds links to a number previously unlinked CVE IDs.
I'll add these new roles to the devguide after merge:
We could also replace the custom
:gh:and:issue:roles, but they perform useful validation (no BPO issues numbered 47261 - 400000, no GitHub issues < 32426).📚 Documentation preview 📚: https://cpython-previews--117850.org.readthedocs.build/