1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
# type: ignore
"""
ticket role
~~~~~~~~~~~
An interpreted text role to link docs to tickets issues.
:copyright: Copyright 2013 by Daniele Varrazzo.
:copyright: Copyright 2021 The Psycopg Team
"""
import re
from docutils import nodes, utils
from docutils.parsers.rst import roles
def ticket_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
cfg = inliner.document.settings.env.app.config
if cfg.ticket_url 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]
rv = [nodes.Text(name + " ")]
tokens = re.findall(r"(#?\d+)|([^\d#]+)", text)
for ticket, noise in tokens:
if ticket:
num = int(ticket.replace("#", ""))
url = cfg.ticket_url % num
roles.set_classes(options)
node = nodes.reference(
ticket, utils.unescape(ticket), refuri=url, **options
)
rv.append(node)
else:
assert noise
rv.append(nodes.Text(noise))
return rv, []
def setup(app):
app.add_config_value("ticket_url", None, "env")
app.add_role("ticket", ticket_role)
app.add_role("tickets", ticket_role)
|
