summaryrefslogtreecommitdiff
path: root/docs/_ext
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2018-08-27 10:26:29 -0400
committerTim Graham <timograham@gmail.com>2018-08-27 10:29:13 -0400
commit44f98f78804627839d5f0a8b3a32bfbb4546ff52 (patch)
tree9e4eb057b6ba2c918cb6e05a297e50be2623080a /docs/_ext
parent7b7fb2eca51dacb5002a4e6b6e1417b36bd5dfd7 (diff)
Replaced CVE/ticket roles with extlinks.
Diffstat (limited to 'docs/_ext')
-rw-r--r--docs/_ext/cve_role.py27
-rw-r--r--docs/_ext/ticket_role.py39
2 files changed, 0 insertions, 66 deletions
diff --git a/docs/_ext/cve_role.py b/docs/_ext/cve_role.py
deleted file mode 100644
index 254d3e679f..0000000000
--- a/docs/_ext/cve_role.py
+++ /dev/null
@@ -1,27 +0,0 @@
-"""
-An interpreted text role to link docs to CVE issues. To use: :cve:`XXXXX`
-"""
-from docutils import nodes, utils
-from docutils.parsers.rst import roles
-
-
-def cve_role(name, rawtext, text, lineno, inliner, options=None, content=None):
- if options is None:
- options = {}
-
- url_pattern = inliner.document.settings.env.app.config.cve_url
- if url_pattern is None:
- msg = inliner.reporter.warning("cve not configured: please configure cve_url in conf.py")
- prb = inliner.problematic(rawtext, rawtext, msg)
- return [prb], [msg]
-
- url = url_pattern % text
- roles.set_classes(options)
- node = nodes.reference(rawtext, utils.unescape('CVE-%s' % text), refuri=url, **options)
- return [node], []
-
-
-def setup(app):
- app.add_config_value('cve_url', None, 'env')
- app.add_role('cve', cve_role)
- return {'parallel_read_safe': True}
diff --git a/docs/_ext/ticket_role.py b/docs/_ext/ticket_role.py
deleted file mode 100644
index 809b4239b2..0000000000
--- a/docs/_ext/ticket_role.py
+++ /dev/null
@@ -1,39 +0,0 @@
-"""
-An interpreted text role to link docs to Trac tickets.
-
-To use: :ticket:`XXXXX`
-
-Based on code from psycopg2 by Daniele Varrazzo.
-"""
-from docutils import nodes, utils
-from docutils.parsers.rst import roles
-
-
-def ticket_role(name, rawtext, text, lineno, inliner, options=None, content=None):
- if options is None:
- options = {}
- try:
- num = int(text.replace('#', ''))
- except ValueError:
- msg = inliner.reporter.error(
- "ticket number must be... a number, got '%s'" % text)
- prb = inliner.problematic(rawtext, rawtext, msg)
- return [prb], [msg]
-
- url_pattern = inliner.document.settings.env.app.config.ticket_url
- if url_pattern is None:
- msg = inliner.reporter.warning(
- "ticket not configured: please configure ticket_url in conf.py")
- prb = inliner.problematic(rawtext, rawtext, msg)
- return [prb], [msg]
-
- url = url_pattern % num
- roles.set_classes(options)
- node = nodes.reference(rawtext, '#' + utils.unescape(text), refuri=url, **options)
- return [node], []
-
-
-def setup(app):
- app.add_config_value('ticket_url', None, 'env')
- app.add_role('ticket', ticket_role)
- return {'parallel_read_safe': True}