Skip to content

Fix the documentation of our custom roles #1823

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

Open
StanFromIreland wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −2
Open

Fix the documentation of our custom roles #1823

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 11 additions & 2 deletions documentation/markup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -707,10 +707,9 @@ where simpler markup should be used:

In addition, the CPython documentation defines a few custom roles:

* ``:cve:`YYYY-NNNNN```: link to a Common Vulnerabilities and Exposures entry.
Copy link
Copy Markdown
Member Author

@StanFromIreland StanFromIreland Jun 4, 2026

Choose a reason for hiding this comment

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

These are part of Sphinx now, e.g.: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-cve

* ``: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.
Copy link
Copy Markdown
Member Author

@StanFromIreland StanFromIreland Jun 4, 2026

Choose a reason for hiding this comment

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

I added it some time ago:

https://github.com/python/cpython/blob/038495db33723849b1c206e1bf7e3af1e1c41f0a/Doc/conf.py#L567

* ``:pypi:`NAME```: link to a project on PyPI.
* ``:source:`PATH```: link to a source file on GitHub.

Expand Down Expand Up @@ -970,6 +969,16 @@ in a different style:

The following roles generate external links:

.. describe:: cve

Link to a `Common Vulnerabilities and Exposures <https://www.cve.org/>`__
entry. You can link to a specific section by using ``:cve:`number#anchor```.

.. describe:: cwe

Link to a `Common Weakness Enumeration <https://cwe.mitre.org/>`__ entry.
You can link to a specific section by using ``:cwe:`number#anchor```.

.. describe:: pep

A reference to a Python Enhancement Proposal. This generates appropriate
Expand Down
Loading