Fix the documentation of our custom roles#1823
Merged
Merged
Conversation
StanFromIreland
commented
Jun 4, 2026
|
|
||
| In addition, the CPython documentation defines a few custom roles: | ||
|
|
||
| * ``:cve:`YYYY-NNNNN```: link to a Common Vulnerabilities and Exposures entry. |
Member
Author
There was a problem hiding this comment.
These are part of Sphinx now, e.g.: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-cve
StanFromIreland
commented
Jun 4, 2026
| * ``:cwe:`NNN```: link to a Common Weakness Enumeration entry. | ||
| * ``:gh:`ID```: link to a GitHub issue. | ||
| * ``:issue:`ID```: link to a bugs.python.com issue. | ||
| * ``:oss-fuzz:`ID```: link to an OSS-Fuzz issue. |
Member
Author
There was a problem hiding this comment.
I added it some time ago:
https://github.com/python/cpython/blob/038495db33723849b1c206e1bf7e3af1e1c41f0a/Doc/conf.py#L567
Documentation build overview
|
hugovk
approved these changes
Jun 11, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.