From fd4cfc6ccfab087dbbf761feafb3b383e17950b2 Mon Sep 17 00:00:00 2001 From: Stan Ulbrych Date: Thu, 4 Jun 2026 16:40:59 +0100 Subject: [PATCH] Fix the documentation of our custom roles --- documentation/markup.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/documentation/markup.rst b/documentation/markup.rst index 282b80f91..41bf5b39c 100644 --- a/documentation/markup.rst +++ b/documentation/markup.rst @@ -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. -* ``: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. * ``:pypi:`NAME```: link to a project on PyPI. * ``:source:`PATH```: link to a source file on GitHub. @@ -970,6 +969,16 @@ in a different style: The following roles generate external links: +.. describe:: cve + + Link to a `Common Vulnerabilities and Exposures `__ + entry. You can link to a specific section by using ``:cve:`number#anchor```. + +.. describe:: cwe + + Link to a `Common Weakness Enumeration `__ 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