diff options
Diffstat (limited to 'sphinx/writers/texinfo.py')
| -rw-r--r-- | sphinx/writers/texinfo.py | 376 |
1 files changed, 188 insertions, 188 deletions
diff --git a/sphinx/writers/texinfo.py b/sphinx/writers/texinfo.py index 77faa63f1..2b9530bac 100644 --- a/sphinx/writers/texinfo.py +++ b/sphinx/writers/texinfo.py @@ -572,19 +572,19 @@ class TexinfoTranslator(nodes.NodeVisitor): # -- Visiting def visit_document(self, node): - # type: (nodes.Node) -> None + # type: (nodes.document) -> None self.footnotestack.append(self.collect_footnotes(node)) self.curfilestack.append(node.get('docname', '')) if 'docname' in node: self.add_anchor(':doc', node) def depart_document(self, node): - # type: (nodes.Node) -> None + # type: (nodes.document) -> None self.footnotestack.pop() self.curfilestack.pop() def visit_Text(self, node): - # type: (nodes.Node) -> None + # type: (nodes.Text) -> None s = self.escape(node.astext()) if self.escape_newlines: s = s.replace('\n', ' ') @@ -594,7 +594,7 @@ class TexinfoTranslator(nodes.NodeVisitor): self.body.append(s) def depart_Text(self, node): - # type: (nodes.Node) -> None + # type: (nodes.Text) -> None pass def visit_section(self, node): @@ -618,7 +618,7 @@ class TexinfoTranslator(nodes.NodeVisitor): self.section_level += 1 def depart_section(self, node): - # type: (nodes.Node) -> None + # type: (nodes.section) -> None self.section_level -= 1 headings = ( @@ -636,7 +636,7 @@ class TexinfoTranslator(nodes.NodeVisitor): ) # type: Tuple[unicode, ...] def visit_title(self, node): - # type: (nodes.Node) -> None + # type: (nodes.title) -> None if not self.seen_title: self.seen_title = True raise nodes.SkipNode @@ -658,11 +658,11 @@ class TexinfoTranslator(nodes.NodeVisitor): self.body.append('\n%s ' % heading) def depart_title(self, node): - # type: (nodes.Node) -> None + # type: (nodes.title) -> None self.body.append('\n\n') def visit_rubric(self, node): - # type: (nodes.Node) -> None + # type: (nodes.rubric) -> None if len(node.children) == 1 and node.children[0].astext() in \ ('Footnotes', _('Footnotes')): raise nodes.SkipNode @@ -674,22 +674,22 @@ class TexinfoTranslator(nodes.NodeVisitor): self.escape_newlines += 1 def depart_rubric(self, node): - # type: (nodes.Node) -> None + # type: (nodes.rubric) -> None self.escape_newlines -= 1 self.body.append('\n\n') def visit_subtitle(self, node): - # type: (nodes.Node) -> None + # type: (nodes.subtitle) -> None self.body.append('\n\n@noindent\n') def depart_subtitle(self, node): - # type: (nodes.Node) -> None + # type: (nodes.subtitle) -> None self.body.append('\n\n') # -- References def visit_target(self, node): - # type: (nodes.Node) -> None + # type: (nodes.target) -> None # postpone the labels until after the sectioning command parindex = node.parent.index(node) try: @@ -714,11 +714,11 @@ class TexinfoTranslator(nodes.NodeVisitor): self.add_anchor(id, node) def depart_target(self, node): - # type: (nodes.Node) -> None + # type: (nodes.target) -> None pass def visit_reference(self, node): - # type: (nodes.Node) -> None + # type: (nodes.reference) -> None # an xref's target is displayed in Info so we ignore a few # cases for the sake of appearance if isinstance(node.parent, (nodes.title, addnodes.desc_type)): @@ -782,17 +782,17 @@ class TexinfoTranslator(nodes.NodeVisitor): raise nodes.SkipNode def depart_reference(self, node): - # type: (nodes.Node) -> None + # type: (nodes.reference) -> None pass def visit_number_reference(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.number_reference) -> None text = nodes.Text(node.get('title', '#')) self.visit_Text(text) raise nodes.SkipNode def visit_title_reference(self, node): - # type: (nodes.Node) -> None + # type: (nodes.title_reference) -> None text = node.astext() self.body.append('@cite{%s}' % self.escape_arg(text)) raise nodes.SkipNode @@ -800,28 +800,28 @@ class TexinfoTranslator(nodes.NodeVisitor): # -- Blocks def visit_paragraph(self, node): - # type: (nodes.Node) -> None + # type: (nodes.paragraph) -> None self.body.append('\n') def depart_paragraph(self, node): - # type: (nodes.Node) -> None + # type: (nodes.paragraph) -> None self.body.append('\n') def visit_block_quote(self, node): - # type: (nodes.Node) -> None + # type: (nodes.block_quote) -> None self.body.append('\n@quotation\n') def depart_block_quote(self, node): - # type: (nodes.Node) -> None + # type: (nodes.block_quote) -> None self.ensure_eol() self.body.append('@end quotation\n') def visit_literal_block(self, node): - # type: (nodes.Node) -> None + # type: (nodes.literal_block) -> None self.body.append('\n@example\n') def depart_literal_block(self, node): - # type: (nodes.Node) -> None + # type: (nodes.literal_block) -> None self.ensure_eol() self.body.append('@end example\n') @@ -829,72 +829,72 @@ class TexinfoTranslator(nodes.NodeVisitor): depart_doctest_block = depart_literal_block def visit_line_block(self, node): - # type: (nodes.Node) -> None + # type: (nodes.line_block) -> None if not isinstance(node.parent, nodes.line_block): self.body.append('\n\n') self.body.append('@display\n') def depart_line_block(self, node): - # type: (nodes.Node) -> None + # type: (nodes.line_block) -> None self.body.append('@end display\n') if not isinstance(node.parent, nodes.line_block): self.body.append('\n\n') def visit_line(self, node): - # type: (nodes.Node) -> None + # type: (nodes.line) -> None self.escape_newlines += 1 def depart_line(self, node): - # type: (nodes.Node) -> None + # type: (nodes.line) -> None self.body.append('@w{ }\n') self.escape_newlines -= 1 # -- Inline def visit_strong(self, node): - # type: (nodes.Node) -> None + # type: (nodes.strong) -> None self.body.append('@strong{') def depart_strong(self, node): - # type: (nodes.Node) -> None + # type: (nodes.strong) -> None self.body.append('}') def visit_emphasis(self, node): - # type: (nodes.Node) -> None + # type: (nodes.emphasis) -> None self.body.append('@emph{') def depart_emphasis(self, node): - # type: (nodes.Node) -> None + # type: (nodes.emphasis) -> None self.body.append('}') def visit_literal(self, node): - # type: (nodes.Node) -> None + # type: (nodes.literal) -> None self.body.append('@code{') def depart_literal(self, node): - # type: (nodes.Node) -> None + # type: (nodes.literal) -> None self.body.append('}') def visit_superscript(self, node): - # type: (nodes.Node) -> None + # type: (nodes.superscript) -> None self.body.append('@w{^') def depart_superscript(self, node): - # type: (nodes.Node) -> None + # type: (nodes.superscript) -> None self.body.append('}') def visit_subscript(self, node): - # type: (nodes.Node) -> None + # type: (nodes.subscript) -> None self.body.append('@w{[') def depart_subscript(self, node): - # type: (nodes.Node) -> None + # type: (nodes.subscript) -> None self.body.append(']}') # -- Footnotes def visit_footnote(self, node): - # type: (nodes.Node) -> None + # type: (nodes.footnote) -> None raise nodes.SkipNode def visit_collected_footnote(self, node): @@ -908,7 +908,7 @@ class TexinfoTranslator(nodes.NodeVisitor): self.in_footnote -= 1 def visit_footnote_reference(self, node): - # type: (nodes.Node) -> None + # type: (nodes.footnote_reference) -> None num = node.astext().strip() try: footnode, used = self.footnotestack[-1][num] @@ -919,38 +919,38 @@ class TexinfoTranslator(nodes.NodeVisitor): raise nodes.SkipChildren def visit_citation(self, node): - # type: (nodes.Node) -> None + # type: (nodes.citation) -> None self.body.append('\n') for id in node.get('ids'): self.add_anchor(id, node) self.escape_newlines += 1 def depart_citation(self, node): - # type: (nodes.Node) -> None + # type: (nodes.citation) -> None self.escape_newlines -= 1 def visit_citation_reference(self, node): - # type: (nodes.Node) -> None + # type: (nodes.citation_reference) -> None self.body.append('@w{[') def depart_citation_reference(self, node): - # type: (nodes.Node) -> None + # type: (nodes.citation_reference) -> None self.body.append(']}') # -- Lists def visit_bullet_list(self, node): - # type: (nodes.Node) -> None + # type: (nodes.bullet_list) -> None bullet = node.get('bullet', '*') self.body.append('\n\n@itemize %s\n' % bullet) def depart_bullet_list(self, node): - # type: (nodes.Node) -> None + # type: (nodes.bullet_list) -> None self.ensure_eol() self.body.append('@end itemize\n') def visit_enumerated_list(self, node): - # type: (nodes.Node) -> None + # type: (nodes.enumerated_list) -> None # doesn't support Roman numerals enum = node.get('enumtype', 'arabic') starters = {'arabic': '', @@ -960,100 +960,100 @@ class TexinfoTranslator(nodes.NodeVisitor): self.body.append('\n\n@enumerate %s\n' % start) def depart_enumerated_list(self, node): - # type: (nodes.Node) -> None + # type: (nodes.enumerated_list) -> None self.ensure_eol() self.body.append('@end enumerate\n') def visit_list_item(self, node): - # type: (nodes.Node) -> None + # type: (nodes.list_item) -> None self.body.append('\n@item ') def depart_list_item(self, node): - # type: (nodes.Node) -> None + # type: (nodes.list_item) -> None pass # -- Option List def visit_option_list(self, node): - # type: (nodes.Node) -> None + # type: (nodes.option_list) -> None self.body.append('\n\n@table @option\n') def depart_option_list(self, node): - # type: (nodes.Node) -> None + # type: (nodes.option_list) -> None self.ensure_eol() self.body.append('@end table\n') def visit_option_list_item(self, node): - # type: (nodes.Node) -> None + # type: (nodes.option_list_item) -> None pass def depart_option_list_item(self, node): - # type: (nodes.Node) -> None + # type: (nodes.option_list_item) -> None pass def visit_option_group(self, node): - # type: (nodes.Node) -> None + # type: (nodes.option_group) -> None self.at_item_x = '@item' def depart_option_group(self, node): - # type: (nodes.Node) -> None + # type: (nodes.option_group) -> None pass def visit_option(self, node): - # type: (nodes.Node) -> None + # type: (nodes.option) -> None self.escape_hyphens += 1 self.body.append('\n%s ' % self.at_item_x) self.at_item_x = '@itemx' def depart_option(self, node): - # type: (nodes.Node) -> None + # type: (nodes.option) -> None self.escape_hyphens -= 1 def visit_option_string(self, node): - # type: (nodes.Node) -> None + # type: (nodes.option_string) -> None pass def depart_option_string(self, node): - # type: (nodes.Node) -> None + # type: (nodes.option_string) -> None pass def visit_option_argument(self, node): - # type: (nodes.Node) -> None + # type: (nodes.option_argument) -> None self.body.append(node.get('delimiter', ' ')) def depart_option_argument(self, node): - # type: (nodes.Node) -> None + # type: (nodes.option_argument) -> None pass def visit_description(self, node): - # type: (nodes.Node) -> None + # type: (nodes.description) -> None self.body.append('\n') def depart_description(self, node): - # type: (nodes.Node) -> None + # type: (nodes.description) -> None pass # -- Definitions def visit_definition_list(self, node): - # type: (nodes.Node) -> None + # type: (nodes.definition_list) -> None self.body.append('\n\n@table @asis\n') def depart_definition_list(self, node): - # type: (nodes.Node) -> None + # type: (nodes.definition_list) -> None self.ensure_eol() self.body.append('@end table\n') def visit_definition_list_item(self, node): - # type: (nodes.Node) -> None + # type: (nodes.definition_list_item) -> None self.at_item_x = '@item' def depart_definition_list_item(self, node): - # type: (nodes.Node) -> None + # type: (nodes.definition_list_item) -> None pass def visit_term(self, node): - # type: (nodes.Node) -> None + # type: (nodes.term) -> None for id in node.get('ids'): self.add_anchor(id, node) # anchors and indexes need to go in front @@ -1065,45 +1065,45 @@ class TexinfoTranslator(nodes.NodeVisitor): self.at_item_x = '@itemx' def depart_term(self, node): - # type: (nodes.Node) -> None + # type: (nodes.term) -> None pass def visit_classifier(self, node): - # type: (nodes.Node) -> None + # type: (nodes.classifier) -> None self.body.append(' : ') def depart_classifier(self, node): - # type: (nodes.Node) -> None + # type: (nodes.classifier) -> None pass def visit_definition(self, node): - # type: (nodes.Node) -> None + # type: (nodes.definition) -> None self.body.append('\n') def depart_definition(self, node): - # type: (nodes.Node) -> None + # type: (nodes.definition) -> None pass # -- Tables def visit_table(self, node): - # type: (nodes.Node) -> None + # type: (nodes.table) -> None self.entry_sep = '@item' def depart_table(self, node): - # type: (nodes.Node) -> None + # type: (nodes.table) -> None self.body.append('\n@end multitable\n\n') def visit_tabular_col_spec(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.tabular_col_spec) -> None pass def depart_tabular_col_spec(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.tabular_col_spec) -> None pass def visit_colspec(self, node): - # type: (nodes.Node) -> None + # type: (nodes.colspec) -> None self.colwidths.append(node['colwidth']) if len(self.colwidths) != self.n_cols: return @@ -1112,97 +1112,97 @@ class TexinfoTranslator(nodes.NodeVisitor): self.body.append('{%s} ' % ('x' * (n + 2))) def depart_colspec(self, node): - # type: (nodes.Node) -> None + # type: (nodes.colspec) -> None pass def visit_tgroup(self, node): - # type: (nodes.Node) -> None + # type: (nodes.tgroup) -> None self.colwidths = [] self.n_cols = node['cols'] def depart_tgroup(self, node): - # type: (nodes.Node) -> None + # type: (nodes.tgroup) -> None pass def visit_thead(self, node): - # type: (nodes.Node) -> None + # type: (nodes.thead) -> None self.entry_sep = '@headitem' def depart_thead(self, node): - # type: (nodes.Node) -> None + # type: (nodes.thead) -> None pass def visit_tbody(self, node): - # type: (nodes.Node) -> None + # type: (nodes.tbody) -> None pass def depart_tbody(self, node): - # type: (nodes.Node) -> None + # type: (nodes.tbody) -> None pass def visit_row(self, node): - # type: (nodes.Node) -> None + # type: (nodes.row) -> None pass def depart_row(self, node): - # type: (nodes.Node) -> None + # type: (nodes.row) -> None self.entry_sep = '@item' def visit_entry(self, node): - # type: (nodes.Node) -> None + # type: (nodes.entry) -> None self.body.append('\n%s\n' % self.entry_sep) self.entry_sep = '@tab' def depart_entry(self, node): - # type: (nodes.Node) -> None + # type: (nodes.entry) -> None for i in range(node.get('morecols', 0)): self.body.append('\n@tab\n') # -- Field Lists def visit_field_list(self, node): - # type: (nodes.Node) -> None + # type: (nodes.field_list) -> None pass def depart_field_list(self, node): - # type: (nodes.Node) -> None + # type: (nodes.field_list) -> None pass def visit_field(self, node): - # type: (nodes.Node) -> None + # type: (nodes.field) -> None self.body.append('\n') def depart_field(self, node): - # type: (nodes.Node) -> None + # type: (nodes.field) -> None self.body.append('\n') def visit_field_name(self, node): - # type: (nodes.Node) -> None + # type: (nodes.field_name) -> None self.ensure_eol() self.body.append('@*') def depart_field_name(self, node): - # type: (nodes.Node) -> None + # type: (nodes.field_name) -> None self.body.append(': ') def visit_field_body(self, node): - # type: (nodes.Node) -> None + # type: (nodes.field_body) -> None pass def depart_field_body(self, node): - # type: (nodes.Node) -> None + # type: (nodes.field_body) -> None pass # -- Admonitions def visit_admonition(self, node, name=''): - # type: (nodes.Node, unicode) -> None + # type: (nodes.admonition, unicode) -> None if not name: name = self.escape(node[0].astext()) self.body.append(u'\n@cartouche\n@quotation %s ' % name) def depart_admonition(self, node): - # type: (nodes.Node) -> None + # type: (nodes.admonition) -> None self.ensure_eol() self.body.append('@end quotation\n' '@end cartouche\n') @@ -1236,41 +1236,41 @@ class TexinfoTranslator(nodes.NodeVisitor): # -- Misc def visit_docinfo(self, node): - # type: (nodes.Node) -> None + # type: (nodes.docinfo) -> None raise nodes.SkipNode def visit_generated(self, node): - # type: (nodes.Node) -> None + # type: (nodes.generated) -> None raise nodes.SkipNode def visit_header(self, node): - # type: (nodes.Node) -> None + # type: (nodes.header) -> None raise nodes.SkipNode def visit_footer(self, node): - # type: (nodes.Node) -> None + # type: (nodes.footer) -> None raise nodes.SkipNode def visit_container(self, node): - # type: (nodes.Node) -> None + # type: (nodes.container) -> None if node.get('literal_block'): self.body.append('\n\n@float LiteralBlock\n') def depart_container(self, node): - # type: (nodes.Node) -> None + # type: (nodes.container) -> None if node.get('literal_block'): self.body.append('\n@end float\n\n') def visit_decoration(self, node): - # type: (nodes.Node) -> None + # type: (nodes.decoration) -> None pass def depart_decoration(self, node): - # type: (nodes.Node) -> None + # type: (nodes.decoration) -> None pass def visit_topic(self, node): - # type: (nodes.Node) -> None + # type: (nodes.topic) -> None # ignore TOC's since we have to have a "menu" anyway if 'contents' in node.get('classes', []): raise nodes.SkipNode @@ -1279,42 +1279,42 @@ class TexinfoTranslator(nodes.NodeVisitor): self.body.append('%s\n' % self.escape(title.astext())) def depart_topic(self, node): - # type: (nodes.Node) -> None + # type: (nodes.topic) -> None pass def visit_transition(self, node): - # type: (nodes.Node) -> None + # type: (nodes.transition) -> None self.body.append('\n\n%s\n\n' % ('_' * 66)) def depart_transition(self, node): - # type: (nodes.Node) -> None + # type: (nodes.transition) -> None pass def visit_attribution(self, node): - # type: (nodes.Node) -> None + # type: (nodes.attribution) -> None self.body.append('\n\n@center --- ') def depart_attribution(self, node): - # type: (nodes.Node) -> None + # type: (nodes.attribution) -> None self.body.append('\n\n') def visit_raw(self, node): - # type: (nodes.Node) -> None + # type: (nodes.raw) -> None format = node.get('format', '').split() if 'texinfo' in format or 'texi' in format: self.body.append(node.astext()) raise nodes.SkipNode def visit_figure(self, node): - # type: (nodes.Node) -> None + # type: (nodes.figure) -> None self.body.append('\n\n@float Figure\n') def depart_figure(self, node): - # type: (nodes.Node) -> None + # type: (nodes.figure) -> None self.body.append('\n@end float\n\n') def visit_caption(self, node): - # type: (nodes.Node) -> None + # type: (nodes.caption) -> None if (isinstance(node.parent, nodes.figure) or (isinstance(node.parent, nodes.container) and node.parent.get('literal_block'))): @@ -1324,14 +1324,14 @@ class TexinfoTranslator(nodes.NodeVisitor): location=(self.curfilestack[-1], node.line)) def depart_caption(self, node): - # type: (nodes.Node) -> None + # type: (nodes.caption) -> None if (isinstance(node.parent, nodes.figure) or (isinstance(node.parent, nodes.container) and node.parent.get('literal_block'))): self.body.append('}\n') def visit_image(self, node): - # type: (nodes.Node) -> None + # type: (nodes.image) -> None if node['uri'] in self.builder.images: uri = self.builder.images[node['uri']] else: @@ -1352,61 +1352,61 @@ class TexinfoTranslator(nodes.NodeVisitor): (name, width, height, alt, ext[1:])) def depart_image(self, node): - # type: (nodes.Node) -> None + # type: (nodes.image) -> None pass def visit_compound(self, node): - # type: (nodes.Node) -> None + # type: (nodes.compound) -> None pass def depart_compound(self, node): - # type: (nodes.Node) -> None + # type: (nodes.compound) -> None pass def visit_sidebar(self, node): - # type: (nodes.Node) -> None + # type: (nodes.sidebar) -> None self.visit_topic(node) def depart_sidebar(self, node): - # type: (nodes.Node) -> None + # type: (nodes.sidebar) -> None self.depart_topic(node) def visit_label(self, node): - # type: (nodes.Node) -> None + # type: (nodes.label) -> None self.body.append('@w{(') def depart_label(self, node): - # type: (nodes.Node) -> None + # type: (nodes.label) -> None self.body.append(')} ') def visit_legend(self, node): - # type: (nodes.Node) -> None + # type: (nodes.legend) -> None pass def depart_legend(self, node): - # type: (nodes.Node) -> None + # type: (nodes.legend) -> None pass def visit_system_message(self, node): - # type: (nodes.Node) -> None + # type: (nodes.system_message) -> None self.body.append('\n@verbatim\n' '<SYSTEM MESSAGE: %s>\n' '@end verbatim\n' % node.astext()) raise nodes.SkipNode def visit_comment(self, node): - # type: (nodes.Node) -> None + # type: (nodes.comment) -> None self.body.append('\n') for line in node.astext().splitlines(): self.body.append('@c %s\n' % line) raise nodes.SkipNode def visit_problematic(self, node): - # type: (nodes.Node) -> None + # type: (nodes.problematic) -> None self.body.append('>>') def depart_problematic(self, node): - # type: (nodes.Node) -> None + # type: (nodes.problematic) -> None self.body.append('<<') def unimplemented_visit(self, node): @@ -1426,7 +1426,7 @@ class TexinfoTranslator(nodes.NodeVisitor): # -- Sphinx specific def visit_productionlist(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.productionlist) -> None self.visit_literal_block(None) names = [] for production in node: @@ -1445,31 +1445,31 @@ class TexinfoTranslator(nodes.NodeVisitor): raise nodes.SkipNode def visit_production(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.production) -> None pass def depart_production(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.production) -> None pass def visit_literal_emphasis(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.literal_emphasis) -> None self.body.append('@code{') def depart_literal_emphasis(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.literal_emphasis) -> None self.body.append('}') def visit_literal_strong(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.literal_strong) -> None self.body.append('@code{') def depart_literal_strong(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.literal_strong) -> None self.body.append('}') def visit_index(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.index) -> None # terminate the line but don't prevent paragraph breaks if isinstance(node.parent, nodes.paragraph): self.ensure_eol() @@ -1481,54 +1481,54 @@ class TexinfoTranslator(nodes.NodeVisitor): self.body.append('@geindex %s\n' % text) def visit_versionmodified(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.versionmodified) -> None self.body.append('\n') def depart_versionmodified(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.versionmodified) -> None self.body.append('\n') def visit_start_of_file(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.start_of_file) -> None # add a document target self.next_section_ids.add(':doc') self.curfilestack.append(node['docname']) self.footnotestack.append(self.collect_footnotes(node)) def depart_start_of_file(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.start_of_file) -> None self.curfilestack.pop() self.footnotestack.pop() def visit_centered(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.centered) -> None txt = self.escape_arg(node.astext()) self.body.append('\n\n@center %s\n\n' % txt) raise nodes.SkipNode def visit_seealso(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.seealso) -> None self.body.append(u'\n\n@subsubheading %s\n\n' % admonitionlabels['seealso']) def depart_seealso(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.seealso) -> None self.body.append('\n') def visit_meta(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.meta) -> None raise nodes.SkipNode def visit_glossary(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.glossary) -> None pass def depart_glossary(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.glossary) -> None pass def visit_acks(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.acks) -> None self.body.append('\n\n') self.body.append(', '.join(n.astext() for n in node.children[0].children) + '.') @@ -1538,18 +1538,18 @@ class TexinfoTranslator(nodes.NodeVisitor): # -- Desc def visit_desc(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc) -> None self.desc = node self.at_deffnx = '@deffn' def depart_desc(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc) -> None self.desc = None self.ensure_eol() self.body.append('@end deffn\n') def visit_desc_signature(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_signature) -> None self.escape_hyphens += 1 objtype = node.parent['objtype'] if objtype != 'describe': @@ -1570,54 +1570,54 @@ class TexinfoTranslator(nodes.NodeVisitor): self.desc_type_name = name def depart_desc_signature(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_signature) -> None self.body.append("\n") self.escape_hyphens -= 1 self.desc_type_name = None def visit_desc_name(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_name) -> None pass def depart_desc_name(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_name) -> None pass def visit_desc_addname(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_addname) -> None pass def depart_desc_addname(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_addname) -> None pass def visit_desc_type(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_type) -> None pass def depart_desc_type(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_type) -> None pass def visit_desc_returns(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_returns) -> None self.body.append(' -> ') def depart_desc_returns(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_returns) -> None pass def visit_desc_parameterlist(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_parameterlist) -> None self.body.append(' (') self.first_param = 1 def depart_desc_parameterlist(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_parameterlist) -> None self.body.append(')') def visit_desc_parameter(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_parameter) -> None if not self.first_param: self.body.append(', ') else: @@ -1629,15 +1629,15 @@ class TexinfoTranslator(nodes.NodeVisitor): raise nodes.SkipNode def visit_desc_optional(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_optional) -> None self.body.append('[') def depart_desc_optional(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_optional) -> None self.body.append(']') def visit_desc_annotation(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_annotation) -> None # Try to avoid duplicating info already displayed by the deffn category. # e.g. # @deffn {Class} Foo @@ -1650,27 +1650,27 @@ class TexinfoTranslator(nodes.NodeVisitor): raise nodes.SkipNode def depart_desc_annotation(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_annotation) -> None pass def visit_desc_content(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_content) -> None pass def depart_desc_content(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.desc_content) -> None pass def visit_inline(self, node): - # type: (nodes.Node) -> None + # type: (nodes.inline) -> None pass def depart_inline(self, node): - # type: (nodes.Node) -> None + # type: (nodes.inline) -> None pass def visit_abbreviation(self, node): - # type: (nodes.Node) -> None + # type: (nodes.abbreviation) -> None abbr = node.astext() self.body.append('@abbr{') if node.hasattr('explanation') and abbr not in self.handled_abbrs: @@ -1680,56 +1680,56 @@ class TexinfoTranslator(nodes.NodeVisitor): self.context.append('}') def depart_abbreviation(self, node): - # type: (nodes.Node) -> None + # type: (nodes.abbreviation) -> None self.body.append(self.context.pop()) def visit_manpage(self, node): - # type: (nodes.Node) -> Any + # type: (addnodes.manpage) -> None return self.visit_literal_emphasis(node) def depart_manpage(self, node): - # type: (nodes.Node) -> Any + # type: (addnodes.manpage) -> None return self.depart_literal_emphasis(node) def visit_download_reference(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.download_reference) -> None pass def depart_download_reference(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.download_reference) -> None pass def visit_hlist(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.hlist) -> None self.visit_bullet_list(node) def depart_hlist(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.hlist) -> None self.depart_bullet_list(node) def visit_hlistcol(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.hlistcol) -> None pass def depart_hlistcol(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.hlistcol) -> None pass def visit_pending_xref(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.pending_xref) -> None pass def depart_pending_xref(self, node): - # type: (nodes.Node) -> None + # type: (addnodes.pending_xref) -> None pass def visit_math(self, node): - # type: (nodes.Node) -> None + # type: (nodes.math) -> None self.body.append('@math{' + self.escape_arg(node.astext()) + '}') raise nodes.SkipNode def visit_math_block(self, node): - # type: (nodes.Node) -> None + # type: (nodes.math_block) -> None if node.get('label'): self.add_anchor(node['label'], node) self.body.append('\n\n@example\n%s\n@end example\n\n' % |