diff options
author | Jakob Lykke Andersen <Jakob@caput.dk> | 2021-03-20 18:16:14 +0300 |
---|---|---|
committer | Jakob Lykke Andersen <Jakob@caput.dk> | 2021-04-12 20:05:58 +0300 |
commit | 3c9a74cb0b9e5ca90adfb1ee55b2262717fae223 (patch) | |
tree | b63766501a1482fa8e34c079e66e8d7385cc9841 /sphinx/writers | |
parent | 14f7d243bd9509d0dab9cace0d9a18fe34b58b92 (diff) |
Decl styling, docs and restructuring
Diffstat (limited to 'sphinx/writers')
-rw-r--r-- | sphinx/writers/html5.py | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/sphinx/writers/html5.py b/sphinx/writers/html5.py index fa7360c4e..745e76b38 100644 --- a/sphinx/writers/html5.py +++ b/sphinx/writers/html5.py @@ -78,6 +78,13 @@ class HTML5Translator(SphinxTranslator, BaseTranslator): def depart_start_of_file(self, node: Element) -> None: self.docnames.pop() + ############################################################# + # Domain-specific object descriptions + ############################################################# + + # Top-level nodes for descriptions + ################################## + def visit_desc(self, node: Element) -> None: self.body.append(self.starttag(node, 'dl', CLASS=node['objtype'])) @@ -104,6 +111,15 @@ class HTML5Translator(SphinxTranslator, BaseTranslator): self.add_permalink_ref(node.parent, _('Permalink to this definition')) self.body.append('<br />') + # Nodes for high-level structure in signatures + ############################################## + + def visit_desc_name(self, node: Element) -> None: + self.body.append(self.starttag(node, 'code', '', CLASS='sig-name descname')) + + def depart_desc_name(self, node: Element) -> None: + self.body.append('</code>') + def visit_desc_addname(self, node: Element) -> None: self.body.append(self.starttag(node, 'code', '', CLASS='sig-prename descclassname')) @@ -122,12 +138,6 @@ class HTML5Translator(SphinxTranslator, BaseTranslator): def depart_desc_returns(self, node: Element) -> None: pass - def visit_desc_name(self, node: Element) -> None: - self.body.append(self.starttag(node, 'code', '', CLASS='sig-name descname')) - - def depart_desc_name(self, node: Element) -> None: - self.body.append('</code>') - def visit_desc_parameterlist(self, node: Element) -> None: self.body.append('<span class="sig-paren">(</span>') self.first_param = 1 |