doc/_themes/odoodoc/html_domain.py

   1 # -*- coding: utf-8 -*-
   2
   3 from docutils import nodes, utils
   4 from docutils.parsers.rst import Directive, directives, docutils
   5 from docutils.parsers.rst.directives.body import LineBlock
   6
   7 from sphinx.domains import Domain
   8
   9 def setup(app):
  10     app.add_domain(HtmlDomain)
  11     app.add_node(div, html=(
  12         lambda self, node: self.body.append(self.starttag(node, 'div')),
  13         lambda self, node: self.body.append('</div>\n')))
  14     app.add_node(address, html=(
  15         lambda self, node: self.body.append(self.starttag(node, 'address')),
  16         lambda self, node: self.body.append('</address>\n')
  17     ))
  18     app.add_node(cite, html=(visit_cite, depart_cite))
  19     for name, node in [('mark', mark), ('ins', insert), ('del', delete),
  20                        ('s', strikethrough), ('u', underline), ('small', small),
  21                        ('kbd', kbd), ('var', var), ('samp', samp)]:
  22         addnode(app, node, name)
  23
  24
  25 class div(nodes.General, nodes.Element): pass
  26 class Div(Directive):
  27     optional_arguments = 1
  28     final_argument_whitespace = 1
  29     has_content = True
  30
  31     def run(self):
  32         self.assert_has_content()
  33         text = '\n'.join(self.content)
  34         try:
  35             if self.arguments:
  36                 classes = directives.class_option(self.arguments[0])
  37             else:
  38                 classes = []
  39         except ValueError:
  40             raise self.error(
  41                 'Invalid class attribute value for "%s" directive: "%s".'
  42                 % (self.name, self.arguments[0]))
  43         node = div(text)
  44         node['classes'].extend(classes)
  45         self.add_name(node)
  46         self.state.nested_parse(self.content, self.content_offset, node)
  47         return [node]
  48
  49 class address(nodes.General, nodes.Element): pass
  50 class Address(LineBlock):
  51     def run(self):
  52         [node] = super(Address, self).run()
  53         ad = address(node.rawsource, *node.children)
  54         return [ad]
  55
  56 class mark(nodes.Inline, nodes.TextElement): pass
  57 class insert(nodes.Inline, nodes.TextElement): pass
  58 class delete(nodes.Inline, nodes.TextElement): pass
  59 class strikethrough(nodes.Inline, nodes.TextElement): pass
  60 class underline(nodes.Inline, nodes.TextElement): pass
  61 class small(nodes.Inline, nodes.TextElement): pass
  62 class kbd(nodes.Inline, nodes.FixedTextElement): pass
  63 class var(nodes.Inline, nodes.FixedTextElement): pass
  64 class samp(nodes.Inline, nodes.FixedTextElement): pass
  65
  66 def makerole(node):
  67     return lambda name, rawtext, text, lineno, inliner, options=None, content=None:\
  68         ([node(rawtext.strip(), text.strip())], [])
  69 def addnode(app, node, nodename):
  70     app.add_node(node, html=(
  71         lambda self, n: self.body.append(self.starttag(n, nodename)),
  72         lambda self, n: self.body.append('</%s>' % nodename)
  73     ))
  74 def initialism(*args, **kwargs):
  75     nodes, _ = sphinx.roles.abbr_role(*args, **kwargs)
  76     [abbr] = nodes
  77     abbr.attributes.setdefault('classes', []).append('initialism')
  78     return [abbr], []
  79
  80 def cite_role(typ, rawtext, text, lineno, inliner, options=None, content=None):
  81     text = utils.unescape(text)
  82     m = sphinx.roles._abbr_re.search(text)
  83     if m is None:
  84         return [cite(text, text, **(options or {}))], []
  85     content = text[:m.start()].strip()
  86     source = m.group(1)
  87     return [cite(content, content, source=source)], []
  88 class cite(nodes.Inline, nodes.TextElement): pass
  89 def visit_cite(self, node):
  90     attrs = {}
  91     if node.hasattr('source'):
  92         attrs['title'] = node['source']
  93     self.body.append(self.starttag(node, 'cite', '', **attrs))
  94 def depart_cite(self, node):
  95     self.body.append('</abbr>')
  96
  97 class HtmlDomain(Domain):
  98     name = 'h'
  99     label = 'HTML'
 100     directives = {
 101         'div': Div,
 102         'address': Address,
 103     }
 104     roles = {
 105         'mark': makerole(mark),
 106         'ins': makerole(insert),
 107         'del': makerole(delete),
 108         's': makerole(strikethrough),
 109         'u': makerole(underline),
 110         'small': makerole(small),
 111         'initialism': initialism,
 112         'cite': cite_role,
 113         'kbd': makerole(kbd),
 114         'var': makerole(var),
 115         'samp': makerole(samp),
 116     }