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
|
from __future__ import annotations
import jinja2
from docutils import nodes
from docutils.parsers.rst import Directive
from docutils.parsers.rst.directives import unchanged
BUTTON_TEMPLATE = jinja2.Template(
'<a href="{{ link }}" class="button"><span>{{ text }}</span></a>'
)
# placeholder node for document graph
class button_node(nodes.General, nodes.Element):
pass
class ButtonDirective(Directive):
required_arguments = 0
option_spec = {"text": unchanged, "link": unchanged}
# this will execute when your directive is encountered
# it will insert a button_node into the document that will
# get visisted during the build phase
def run(self):
node = button_node()
node["text"] = self.options["text"]
node["link"] = self.options["link"]
return [node]
# build phase visitor emits HTML to append to output
def html_visit_button_node(self, node):
html = BUTTON_TEMPLATE.render(text=node["text"], link=node["link"])
self.body.append(html)
raise nodes.SkipNode
# if you want to be pedantic, define text, latex, manpage visitors too..
def setup(app):
app.add_node(button_node, html=(html_visit_button_node, None))
app.add_directive("button", ButtonDirective)
return {"parallel_read_safe": True}
|
