IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

[texinfo] Render desc_annotation nodes instead of skipping them.

Browse Source
This commit is contained in:
Jonathan Waltman 2013-02-19 19:31:48 -06:00
parent 5078d81755
commit 3a30bafb28
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
sphinx/writers/texinfo.py
View File

@ -1263,8 +1263,10 @@ class TexinfoTranslator(nodes.NodeVisitor):
## Desc
def visit_desc(self, node):
self.desc = node
self.at_deffnx = '@deffn'
def depart_desc(self, node):
self.desc = None
self.ensure_eol()
self.body.append('@end deffn\n')
@ -1285,9 +1287,11 @@ class TexinfoTranslator(nodes.NodeVisitor):
category = self.escape_arg(string.capwords(name))
self.body.append('\n%s {%s} ' % (self.at_deffnx, category))
self.at_deffnx = '@deffnx'
self.desc_type_name = name
def depart_desc_signature(self, node):
self.body.append("\n")
self.escape_hyphens -= 1
self.desc_type_name = None
def visit_desc_name(self, node):
pass
@ -1332,7 +1336,18 @@ class TexinfoTranslator(nodes.NodeVisitor):
self.body.append(']')
def visit_desc_annotation(self, node):
raise nodes.SkipNode
# Try to avoid duplicating info already displayed by the deffn category.
# e.g.
# @deffn {Class} Foo
# -- instead of --
# @deffn {Class} class Foo
txt = node.astext().strip()
if txt == self.desc['desctype'] or \
txt == self.desc['objtype'] or \
txt in self.desc_type_name.split():
raise nodes.SkipNode
def depart_desc_annotation(self, node):
pass
def visit_desc_content(self, node):
pass