a088802245
The structure of the `dfn` role is changed from its default
`<em class="dfn">text</em>` to
`<span class="dfn"><span>text</span></span>` to ease the styling.
task-3046383
X-original-commit: 281a893540
Part-of: odoo/documentation#4108
76 lines
2.0 KiB
Python
76 lines
2.0 KiB
Python
""" Add new custom admonition directives. """
|
|
|
|
from docutils import nodes
|
|
from docutils.parsers.rst.directives import admonitions
|
|
from sphinx.locale import admonitionlabels
|
|
from sphinx.util.docutils import SphinxRole
|
|
|
|
|
|
class example(nodes.Admonition, nodes.Element):
|
|
pass
|
|
|
|
|
|
class Example(admonitions.BaseAdmonition):
|
|
node_class = example
|
|
|
|
|
|
class exercise(nodes.Admonition, nodes.Element):
|
|
pass
|
|
|
|
|
|
class Exercise(admonitions.BaseAdmonition):
|
|
node_class = exercise
|
|
|
|
|
|
class Dfn(SphinxRole):
|
|
""" Overwrite the `dfn` role to use custom HTML. """
|
|
|
|
def run(self):
|
|
""" Process the content of the role.
|
|
|
|
We use custom node classes to represent the `span`s rather than the corresponding
|
|
sphinx.nodes.* class to prevent automatically setting the name of the node as class (e.g.,
|
|
"container") on the element.
|
|
"""
|
|
outer_span = Span(classes=['dfn'])
|
|
inner_span = Span()
|
|
outer_span.append(inner_span)
|
|
text = nodes.Text(self.text)
|
|
inner_span.append(text)
|
|
return [outer_span], []
|
|
|
|
|
|
class Span(nodes.General, nodes.Element):
|
|
|
|
@staticmethod
|
|
def visit(translator, node):
|
|
translator.body.append(translator.starttag(node, 'span').rstrip())
|
|
|
|
@staticmethod
|
|
def depart(translator, node):
|
|
translator.body.append('</span>')
|
|
|
|
|
|
def setup(app):
|
|
app.add_directive('example', Example)
|
|
app.add_node(example, html=(
|
|
lambda self, node: self.visit_admonition(node, 'example'),
|
|
lambda self, node: self.depart_admonition(node),
|
|
))
|
|
app.add_directive('exercise', Exercise)
|
|
app.add_node(exercise, html=(
|
|
lambda self, node: self.visit_admonition(node, 'exercise'),
|
|
lambda self, node: self.depart_admonition(node),
|
|
))
|
|
app.add_role('dfn', Dfn(), override=True)
|
|
app.add_node(Span, html=(Span.visit, Span.depart))
|
|
|
|
return {
|
|
'parallel_read_safe': True,
|
|
'parallel_write_safe': True
|
|
}
|
|
|
|
|
|
admonitionlabels['example'] = 'Example'
|
|
admonitionlabels['exercise'] = 'Exercise'
|