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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
"""Some common helper functions for the test suite."""
import re
from typing import Optional
import docutils
RE_ID = r"[a-z][-?a-z0-9]*"
RE_NUM = r"\d+"
RE_LABEL = r"[^<]+"
RE_TEXT = r".*"
RE_DOCNAME = r"[^:]+"
RE_TITLE = r'[^"]*'
def html_citation_refs(refid=RE_ID, label=RE_LABEL, title: Optional[str] = RE_TITLE):
title_pattern = rf' title="(?P<title>{title})"' if title is not None else ""
return re.compile(
r'<a class="reference internal"'
r' href="(?P<refdoc>[^#]+)?#(?P<refid>{refid})"'
r"{title_pattern}"
r">"
r"(?P<label>{label})"
r"</a>".format(refid=refid, label=label, title_pattern=title_pattern)
)
# match single citation with square brackets
# also gets the id of the citation itself (which will appear in backref)
def html_citation_refs_single(
id_=RE_ID, refid=RE_ID, label=RE_LABEL, title: Optional[str] = RE_TITLE
):
title_pattern = rf' title="{title}"' if title is not None else ""
return re.compile(
r'<span id="(?P<id_>{id_})">\['
r'<a class="reference internal"'
r' href="(?P<refdoc>[^#]+)?#(?P<refid>{refid})"'
r"{title_pattern}"
r">"
r"(?P<label>{label})"
r"</a>"
r"]</span>".format(
id_=id_, refid=refid, label=label, title_pattern=title_pattern
)
)
def html_docutils_citation_refs(refid=RE_ID, label=RE_LABEL, id_=RE_ID):
return re.compile(
r'<a class="reference internal" '
r'href="(?P<refdoc>[^#]+)?#(?P<refid>{refid})" '
r'id="(?P<id_>{id_})">'
r"<span>\[(?P<label>{label})]</span>"
r"</a>".format(refid=refid, label=label, id_=id_)
)
def html_citations(id_=RE_ID, label=RE_LABEL, text=RE_TEXT):
if docutils.__version_info__ < (0, 18):
return re.compile(
r'<dt class="label" id="(?P<id_>{id_})">'
r'<span class="brackets">'
r'(?:<a class="fn-backref" href="#(?P<backref>{backref_id})">)?'
r"(?P<label>{label})"
r"(?:</a>)?"
r"</span>"
r'(?:<span class="fn-backref">\('
r'<a href="#(?P<backref1>{backref_id})">1</a>'
r',<a href="#(?P<backref2>{backref_id}\w+)">2</a>'
r'(,<a href="#(?P<backref3>{backref_id}\w+)">3</a>)?'
r'(,<a href="#\w+">\d+</a>)*' # no named group for extra backrefs
r"\)</span>)?"
r"</dt>\n"
r"<dd><p>(?P<text>{text})</p>\n</dd>".format(
id_=id_, label=label, text=text, backref_id=RE_ID
)
)
else:
return re.compile(
r'<div class="citation" id="(?P<id_>{id_})"'
r' role="doc-biblioentry">\s*'
r'<span class="label">'
r'<span class="fn-bracket">\[</span>'
r'(?:<a role="doc-backlink" href="#(?P<backref>{backref_id})">)?'
r"(?P<label>{label})"
r"(?:</a>)?"
r'<span class="fn-bracket">]</span>'
r"</span>\s*"
r'(?:<span class="backrefs">\('
r'<a {back_role} href="#(?P<backref1>{backref_id})">1</a>'
r',<a {back_role} href="#(?P<backref2>{backref_id}\w+)">2</a>'
r'(,<a {back_role} href="#(?P<backref3>{backref_id}\w+)">3</a>)?'
r'(,<a {back_role} href="#\w+">\d+</a>)*'
r"\)</span>\s*)?"
r"<p>(?P<text>{text})</p>\s*"
r"</div>".format(
back_role='role="doc-backlink"',
id_=id_,
label=label,
text=text,
backref_id=RE_ID,
)
)
def html_footnote_refs(refid=RE_ID):
if docutils.__version_info__ < (0, 18):
return re.compile(
r'<a class="footnote-reference brackets"'
r' href="#(?P<refid>{refid})" id="(?P<id_>{id_})">'
r"(?P<label>{label})"
r"</a>".format(refid=refid, id_=RE_ID, label=RE_NUM)
)
else:
return re.compile(
r'<a class="footnote-reference brackets" '
r'href="#(?P<refid>{refid})" id="(?P<id_>{id_})" '
r'role="doc-noteref">'
r'<span class="fn-bracket">\[</span>'
r"(?P<label>{label})"
r'<span class="fn-bracket">]</span>'
r"</a>".format(refid=refid, id_=RE_ID, label=RE_NUM)
)
def html_footnotes(id_=RE_ID, text=RE_TEXT):
if docutils.__version_info__ < (0, 18):
return re.compile(
r'<dt class="label" id="(?P<id_>{id_})">'
r'<span class="brackets">'
r'(?:<a class="fn-backref" href="#(?P<backref>{backref_id})">)?'
r"(?P<label>{label})"
r"(?:</a>)?"
r"</span>"
r'(?:<span class="fn-backref">\('
r'<a href="#(?P<backref1>{backref_id})">1</a>'
r',<a href="#(?P<backref2>{backref_id}\w+)">2</a>'
r'(,<a href="#(?P<backref3>{backref_id}\w+)">3</a>)?'
r'(,<a href="#\w+">\d+</a>)*'
r"\)</span>)?"
r"</dt>\n"
r"<dd><p>(?P<text>{text})</p>\n</dd>".format(
id_=id_, backref_id=RE_ID, label=RE_NUM, text=text
)
)
else:
foot_role = (
'role="note"'
if docutils.__version_info__ < (0, 20)
else 'role="doc-footnote"'
)
return re.compile(
r'<aside class="footnote brackets" id="(?P<id_>{id_})"'
r" {foot_role}>\s*"
r'<span class="label">'
r'<span class="fn-bracket">\[</span>'
r'(?:<a {back_role} href="#(?P<backref>{backref_id})">)?'
r"{label}"
r"(?:</a>)?"
r'<span class="fn-bracket">]</span>'
r"</span>\s*"
r'(?:<span class="backrefs">\('
r'<a {back_role} href="#(?P<backref1>{backref_id})">1</a>'
r',<a {back_role} href="#(?P<backref2>{backref_id}\w+)">2</a>'
r'(,<a {back_role} href="#(?P<backref3>{backref_id}\w+)">3</a>)?'
r'(,<a {back_role} href="#\w+">\d+</a>)*'
r"\)</span>\s*)?"
r"<p>(?P<text>{text})</p>\s*"
r"</aside>".format(
foot_role=foot_role,
back_role='role="doc-backlink"',
id_=id_,
label=RE_NUM,
text=text,
backref_id=RE_ID,
)
)
def latex_citations(docname=RE_DOCNAME, id_=RE_ID, label=RE_LABEL, text=RE_TEXT):
return re.compile(
r"\\bibitem\[(?P<label>{label})]"
r"{{(?P<docname>{docname}):(?P<id_>{id_})}}\n"
r"\\sphinxAtStartPar\n"
r"(?P<text>{text})\n".format(docname=docname, label=label, id_=id_, text=text)
)
def latex_citation_refs(docname=RE_DOCNAME, refid=RE_ID):
return re.compile(
rf"\\hyperlink{{cite[.](?P<docname>{docname}):(?P<refid>{refid})}}"
)
|
