/
numfig.py
174 lines (133 loc) · 6.04 KB
/
numfig.py
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
from docutils import nodes
from sphinx.roles import XRefRole
import figtable
import subfig
from backports import OrderedDict, OrderedSet
# Element classes
class page_ref(nodes.reference):
pass
class num_ref(nodes.reference):
pass
# Visit/depart functions
def skip_page_ref(self, node):
raise nodes.SkipNode
def latex_visit_page_ref(self, node):
self.body.append("\\pageref{%s:%s}" % (node['refdoc'], node['reftarget']))
raise nodes.SkipNode
def latex_visit_num_ref(self, node):
fields = node['reftarget'].split('#')
if len(fields) > 1:
label, target = fields
else:
label = None
target = fields[0]
if target not in self.builder.env.docnames_by_figname:
raise nodes.SkipNode
targetdoc = self.builder.env.docnames_by_figname[target]
ref_link = '%s:%s' % (targetdoc, target)
if label is None:
latex = '\\ref{%s}' % ref_link
else:
latex = "\\hyperref[%s]{%s \\ref*{%s}}" % (ref_link, label, ref_link)
self.body.append(latex)
raise nodes.SkipNode
def doctree_read(app, doctree):
# first generate figure numbers for each figure
env = app.builder.env
docname_figs = getattr(env, 'docname_figs', {})
docnames_by_figname = getattr(env, 'docnames_by_figname', {})
for figure_info in doctree.traverse(lambda n: isinstance(n, nodes.figure) or \
isinstance(n, subfig.subfigend) or \
isinstance(n, figtable.figtable)):
for id in figure_info['ids']:
docnames_by_figname[id] = env.docname
fig_docname = docnames_by_figname[id]
if fig_docname not in docname_figs:
docname_figs[fig_docname] = OrderedDict()
if isinstance(figure_info.parent, subfig.subfig):
mainid = figure_info.parent['mainfigid']
else:
mainid = id
if mainid not in docname_figs[fig_docname]:
docname_figs[fig_docname][mainid] = OrderedSet()
if isinstance(figure_info.parent, subfig.subfig):
docname_figs[fig_docname][mainid].add(id)
env.docnames_by_figname = docnames_by_figname
env.docname_figs = docname_figs
def doctree_resolved(app, doctree, docname):
# replace numfig nodes with links
if app.builder.name in ('html', 'singlehtml', 'epub'):
env = app.builder.env
docname_figs = getattr(env, 'docname_figs', {})
docnames_by_figname = env.docnames_by_figname
figids = getattr(env, 'figids', {})
secnums = []
fignames_by_secnum = {}
for figdocname, figurelist in env.docname_figs.iteritems():
if figdocname not in env.toc_secnumbers:
continue
secnum = env.toc_secnumbers[figdocname]['']
secnums.append(secnum)
fignames_by_secnum[secnum] = figurelist
last_secnum = 0
secnums = sorted(secnums)
figid = 1
for secnum in secnums:
if secnum[0] != last_secnum:
figid = 1
for figname, subfigs in fignames_by_secnum[secnum].iteritems():
figids[figname] = str(secnum[0]) + '.' + str(figid)
for i, subfigname in enumerate(subfigs):
subfigid = figids[figname] + chr(ord('a') + i)
figids[subfigname] = subfigid
figid += 1
last_secnum = secnum[0]
env.figids = figids
for figure_info in doctree.traverse(lambda n: isinstance(n, nodes.figure) or \
isinstance(n, subfig.subfigend) or \
isinstance(n, figtable.figtable)):
id = figure_info['ids'][0]
fignum = figids[id]
for cap in figure_info.traverse(nodes.caption):
cap.insert(1, nodes.Text(" %s" % cap[0]))
if fignum[-1] in map(str, range(10)):
boldcaption = "%s %s:" % (app.config.figure_caption_prefix, fignum)
else:
boldcaption = "(%s)" % fignum[-1]
cap[0] = nodes.strong('', boldcaption)
for ref_info in doctree.traverse(num_ref):
if '#' in ref_info['reftarget']:
label, target = ref_info['reftarget'].split('#')
labelfmt = label + " %s"
else:
labelfmt = '%s'
target = ref_info['reftarget']
if target not in docnames_by_figname:
app.warn('Target figure not found: %s' % target)
link = "#%s" % target
linktext = target
else:
target_doc = docnames_by_figname[target]
if app.builder.name == 'singlehtml':
link = "#%s" % target
else:
link = "%s#%s" % (app.builder.get_relative_uri(docname, target_doc),
target)
linktext = labelfmt % figids[target]
html = '<a href="%s">%s</a>' % (link, linktext)
ref_info.replace_self(nodes.raw(html, html, format='html'))
def setup(app):
app.add_config_value('number_figures', True, True)
app.add_config_value('figure_caption_prefix', "Figure", True)
app.add_node(page_ref,
text=(skip_page_ref, None),
html=(skip_page_ref, None),
singlehtml=(skip_page_ref, None),
latex=(latex_visit_page_ref, None))
app.add_role('page', XRefRole(nodeclass=page_ref))
app.add_node(num_ref,
latex=(latex_visit_num_ref, None),
text=(skip_page_ref, None))
app.add_role('num', XRefRole(nodeclass=num_ref))
app.connect('doctree-read', doctree_read)
app.connect('doctree-resolved', doctree_resolved)