mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Move CVE and CWE base URLs to class constants
This commit is contained in:
parent
58263e2cb0
commit
ca9944708f
@ -54,10 +54,6 @@ default_settings: dict[str, Any] = {
|
|||||||
'image_loading': 'link',
|
'image_loading': 'link',
|
||||||
'embed_stylesheet': False,
|
'embed_stylesheet': False,
|
||||||
'cloak_email_addresses': True,
|
'cloak_email_addresses': True,
|
||||||
'cve_base_url': 'https://www.cve.org/CVERecord?id=CVE-',
|
|
||||||
'cve_references': None,
|
|
||||||
'cwe_base_url': 'https://cwe.mitre.org/data/definitions/',
|
|
||||||
'cwe_references': None,
|
|
||||||
'pep_base_url': 'https://peps.python.org/',
|
'pep_base_url': 'https://peps.python.org/',
|
||||||
'pep_references': None,
|
'pep_references': None,
|
||||||
'rfc_base_url': 'https://datatracker.ietf.org/doc/html/',
|
'rfc_base_url': 'https://datatracker.ietf.org/doc/html/',
|
||||||
|
@ -17,6 +17,7 @@ from sphinx.util.docutils import ReferenceRole, SphinxRole
|
|||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from collections.abc import Sequence
|
from collections.abc import Sequence
|
||||||
|
from typing import Final
|
||||||
|
|
||||||
from docutils.nodes import Element, Node, TextElement, system_message
|
from docutils.nodes import Element, Node, TextElement, system_message
|
||||||
|
|
||||||
@ -197,6 +198,8 @@ class AnyXRefRole(XRefRole):
|
|||||||
|
|
||||||
|
|
||||||
class CVE(ReferenceRole):
|
class CVE(ReferenceRole):
|
||||||
|
_BASE_URL: Final = 'https://www.cve.org/CVERecord?id=CVE-'
|
||||||
|
|
||||||
def run(self) -> tuple[list[Node], list[system_message]]:
|
def run(self) -> tuple[list[Node], list[system_message]]:
|
||||||
target_id = f'index-{self.env.new_serialno("index")}'
|
target_id = f'index-{self.env.new_serialno("index")}'
|
||||||
entries = [
|
entries = [
|
||||||
@ -233,14 +236,15 @@ class CVE(ReferenceRole):
|
|||||||
return [index, target, reference], []
|
return [index, target, reference], []
|
||||||
|
|
||||||
def build_uri(self) -> str:
|
def build_uri(self) -> str:
|
||||||
base_url = self.inliner.document.settings.cve_base_url
|
|
||||||
ret = self.target.split('#', 1)
|
ret = self.target.split('#', 1)
|
||||||
if len(ret) == 2:
|
if len(ret) == 2:
|
||||||
return f'{base_url}{ret[0]}#{ret[1]}'
|
return f'{CVE._BASE_URL}{ret[0]}#{ret[1]}'
|
||||||
return f'{base_url}{ret[0]}'
|
return f'{CVE._BASE_URL}{ret[0]}'
|
||||||
|
|
||||||
|
|
||||||
class CWE(ReferenceRole):
|
class CWE(ReferenceRole):
|
||||||
|
_BASE_URL: Final = 'https://cwe.mitre.org/data/definitions/'
|
||||||
|
|
||||||
def run(self) -> tuple[list[Node], list[system_message]]:
|
def run(self) -> tuple[list[Node], list[system_message]]:
|
||||||
target_id = f'index-{self.env.new_serialno("index")}'
|
target_id = f'index-{self.env.new_serialno("index")}'
|
||||||
entries = [
|
entries = [
|
||||||
@ -277,11 +281,10 @@ class CWE(ReferenceRole):
|
|||||||
return [index, target, reference], []
|
return [index, target, reference], []
|
||||||
|
|
||||||
def build_uri(self) -> str:
|
def build_uri(self) -> str:
|
||||||
base_url = self.inliner.document.settings.cwe_base_url
|
|
||||||
ret = self.target.split('#', 1)
|
ret = self.target.split('#', 1)
|
||||||
if len(ret) == 2:
|
if len(ret) == 2:
|
||||||
return f'{base_url}{int(ret[0])}.html#{ret[1]}'
|
return f'{CWE._BASE_URL}{int(ret[0])}.html#{ret[1]}'
|
||||||
return f'{base_url}{int(ret[0])}.html'
|
return f'{CWE._BASE_URL}{int(ret[0])}.html'
|
||||||
|
|
||||||
|
|
||||||
class PEP(ReferenceRole):
|
class PEP(ReferenceRole):
|
||||||
|
Loading…
Reference in New Issue
Block a user