sphinx.writers.texinfo.TexinfoTranslator

class documentation

class TexinfoTranslator(SphinxTranslator):

Undocumented

Method	`__init__`	Undocumented
Method	`_visit_named_admonition`	Undocumented
Method	`add_anchor`	Undocumented
Method	`add_menu`	Undocumented
Method	`add_menu_entries`	Undocumented
Method	`add_xref`	Undocumented
Method	`collect_footnotes`	Undocumented
Method	`collect_indices`	Undocumented
Method	`collect_node_menus`	Collect the menu entries for each "node" section.
Method	`collect_node_names`	Generates a unique id for each section.
Method	`collect_rellinks`	Collect the relative links (next, previous, up) for each "node".
Method	`depart_abbreviation`	Undocumented
Method	`depart_admonition`	Undocumented
Method	`depart_attribution`	Undocumented
Method	`depart_block_quote`	Undocumented
Method	`depart_bullet_list`	Undocumented
Method	`depart_caption`	Undocumented
Method	`depart_citation`	Undocumented
Method	`depart_citation_reference`	Undocumented
Method	`depart_classifier`	Undocumented
Method	`depart_collected_footnote`	Undocumented
Method	`depart_colspec`	Undocumented
Method	`depart_compound`	Undocumented
Method	`depart_container`	Undocumented
Method	`depart_decoration`	Undocumented
Method	`depart_definition`	Undocumented
Method	`depart_definition_list`	Undocumented
Method	`depart_definition_list_item`	Undocumented
Method	`depart_desc`	Undocumented
Method	`depart_desc_addname`	Undocumented
Method	`depart_desc_annotation`	Undocumented
Method	`depart_desc_content`	Undocumented
Method	`depart_desc_inline`	Undocumented
Method	`depart_desc_name`	Undocumented
Method	`depart_desc_optional`	Undocumented
Method	`depart_desc_parameterlist`	Undocumented
Method	`depart_desc_returns`	Undocumented
Method	`depart_desc_signature`	Undocumented
Method	`depart_desc_signature_line`	Undocumented
Method	`depart_desc_type`	Undocumented
Method	`depart_description`	Undocumented
Method	`depart_document`	Undocumented
Method	`depart_download_reference`	Undocumented
Method	`depart_emphasis`	Undocumented
Method	`depart_entry`	Undocumented
Method	`depart_enumerated_list`	Undocumented
Method	`depart_field`	Undocumented
Method	`depart_field_body`	Undocumented
Method	`depart_field_list`	Undocumented
Method	`depart_field_name`	Undocumented
Method	`depart_figure`	Undocumented
Method	`depart_glossary`	Undocumented
Method	`depart_hlist`	Undocumented
Method	`depart_hlistcol`	Undocumented
Method	`depart_image`	Undocumented
Method	`depart_inline`	Undocumented
Method	`depart_label`	Undocumented
Method	`depart_legend`	Undocumented
Method	`depart_line`	Undocumented
Method	`depart_line_block`	Undocumented
Method	`depart_list_item`	Undocumented
Method	`depart_literal`	Undocumented
Method	`depart_literal_block`	Undocumented
Method	`depart_literal_emphasis`	Undocumented
Method	`depart_literal_strong`	Undocumented
Method	`depart_manpage`	Undocumented
Method	`depart_option`	Undocumented
Method	`depart_option_argument`	Undocumented
Method	`depart_option_group`	Undocumented
Method	`depart_option_list`	Undocumented
Method	`depart_option_list_item`	Undocumented
Method	`depart_option_string`	Undocumented
Method	`depart_paragraph`	Undocumented
Method	`depart_pending_xref`	Undocumented
Method	`depart_problematic`	Undocumented
Method	`depart_production`	Undocumented
Method	`depart_reference`	Undocumented
Method	`depart_row`	Undocumented
Method	`depart_rubric`	Undocumented
Method	`depart_section`	Undocumented
Method	`depart_seealso`	Undocumented
Method	`depart_sidebar`	Undocumented
Method	`depart_start_of_file`	Undocumented
Method	`depart_strong`	Undocumented
Method	`depart_subscript`	Undocumented
Method	`depart_substitution_reference`	Undocumented
Method	`depart_subtitle`	Undocumented
Method	`depart_superscript`	Undocumented
Method	`depart_table`	Undocumented
Method	`depart_tabular_col_spec`	Undocumented
Method	`depart_target`	Undocumented
Method	`depart_tbody`	Undocumented
Method	`depart_term`	Undocumented
Method	`depart_Text`	Undocumented
Method	`depart_tgroup`	Undocumented
Method	`depart_thead`	Undocumented
Method	`depart_title`	Undocumented
Method	`depart_topic`	Undocumented
Method	`depart_transition`	Undocumented
Method	`depart_versionmodified`	Undocumented
Method	`ensure_eol`	Ensure the last line in body is terminated by new line.
Method	`escape`	Return a string with Texinfo command characters escaped.
Method	`escape_arg`	Return an escaped string suitable for use as an argument to a Texinfo command.
Method	`escape_id`	Return an escaped string suitable for node names and anchors.
Method	`escape_menu`	Return an escaped string suitable for menu entries.
Method	`finish`	Undocumented
Method	`format_menu_entry`	Undocumented
Method	`get_short_id`	Return a shorter 'id' associated with `id`.
Method	`init_settings`	Undocumented
Method	`is_samp`	Undocumented
Method	`tex_image_length`	Undocumented
Method	`unimplemented_visit`	Undocumented
Method	`unknown_departure`	Undocumented
Method	`visit_abbreviation`	Undocumented
Method	`visit_acks`	Undocumented
Method	`visit_admonition`	Undocumented
Method	`visit_attribution`	Undocumented
Method	`visit_block_quote`	Undocumented
Method	`visit_bullet_list`	Undocumented
Method	`visit_caption`	Undocumented
Method	`visit_centered`	Undocumented
Method	`visit_citation`	Undocumented
Method	`visit_citation_reference`	Undocumented
Method	`visit_classifier`	Undocumented
Method	`visit_collected_footnote`	Undocumented
Method	`visit_colspec`	Undocumented
Method	`visit_comment`	Undocumented
Method	`visit_compound`	Undocumented
Method	`visit_container`	Undocumented
Method	`visit_decoration`	Undocumented
Method	`visit_definition`	Undocumented
Method	`visit_definition_list`	Undocumented
Method	`visit_definition_list_item`	Undocumented
Method	`visit_desc`	Undocumented
Method	`visit_desc_addname`	Undocumented
Method	`visit_desc_annotation`	Undocumented
Method	`visit_desc_content`	Undocumented
Method	`visit_desc_inline`	Undocumented
Method	`visit_desc_name`	Undocumented
Method	`visit_desc_optional`	Undocumented
Method	`visit_desc_parameter`	Undocumented
Method	`visit_desc_parameterlist`	Undocumented
Method	`visit_desc_returns`	Undocumented
Method	`visit_desc_signature`	Undocumented
Method	`visit_desc_signature_line`	Undocumented
Method	`visit_desc_type`	Undocumented
Method	`visit_description`	Undocumented
Method	`visit_docinfo`	Undocumented
Method	`visit_document`	Undocumented
Method	`visit_download_reference`	Undocumented
Method	`visit_emphasis`	Undocumented
Method	`visit_entry`	Undocumented
Method	`visit_enumerated_list`	Undocumented
Method	`visit_field`	Undocumented
Method	`visit_field_body`	Undocumented
Method	`visit_field_list`	Undocumented
Method	`visit_field_name`	Undocumented
Method	`visit_figure`	Undocumented
Method	`visit_footer`	Undocumented
Method	`visit_footnote`	Undocumented
Method	`visit_footnote_reference`	Undocumented
Method	`visit_generated`	Undocumented
Method	`visit_glossary`	Undocumented
Method	`visit_header`	Undocumented
Method	`visit_hlist`	Undocumented
Method	`visit_hlistcol`	Undocumented
Method	`visit_image`	Undocumented
Method	`visit_index`	Undocumented
Method	`visit_inline`	Undocumented
Method	`visit_label`	Undocumented
Method	`visit_legend`	Undocumented
Method	`visit_line`	Undocumented
Method	`visit_line_block`	Undocumented
Method	`visit_list_item`	Undocumented
Method	`visit_literal`	Undocumented
Method	`visit_literal_block`	Undocumented
Method	`visit_literal_emphasis`	Undocumented
Method	`visit_literal_strong`	Undocumented
Method	`visit_manpage`	Undocumented
Method	`visit_math`	Undocumented
Method	`visit_math_block`	Undocumented
Method	`visit_meta`	Undocumented
Method	`visit_number_reference`	Undocumented
Method	`visit_option`	Undocumented
Method	`visit_option_argument`	Undocumented
Method	`visit_option_group`	Undocumented
Method	`visit_option_list`	Undocumented
Method	`visit_option_list_item`	Undocumented
Method	`visit_option_string`	Undocumented
Method	`visit_paragraph`	Undocumented
Method	`visit_pending_xref`	Undocumented
Method	`visit_problematic`	Undocumented
Method	`visit_production`	Undocumented
Method	`visit_productionlist`	Undocumented
Method	`visit_raw`	Undocumented
Method	`visit_reference`	Undocumented
Method	`visit_row`	Undocumented
Method	`visit_rubric`	Undocumented
Method	`visit_section`	Undocumented
Method	`visit_seealso`	Undocumented
Method	`visit_sidebar`	Undocumented
Method	`visit_start_of_file`	Undocumented
Method	`visit_strong`	Undocumented
Method	`visit_subscript`	Undocumented
Method	`visit_substitution_definition`	Undocumented
Method	`visit_substitution_reference`	Undocumented
Method	`visit_subtitle`	Undocumented
Method	`visit_superscript`	Undocumented
Method	`visit_system_message`	Undocumented
Method	`visit_table`	Undocumented
Method	`visit_tabular_col_spec`	Undocumented
Method	`visit_target`	Undocumented
Method	`visit_tbody`	Undocumented
Method	`visit_term`	Undocumented
Method	`visit_Text`	Undocumented
Method	`visit_tgroup`	Undocumented
Method	`visit_thead`	Undocumented
Method	`visit_title`	Undocumented
Method	`visit_title_reference`	Undocumented
Method	`visit_topic`	Undocumented
Method	`visit_transition`	Undocumented
Method	`visit_versionmodified`	Undocumented
Class Variable	`builder`	Undocumented
Class Variable	`default_elements`	Undocumented
Class Variable	`headings`	Undocumented
Class Variable	`ignore_missing_images`	Undocumented
Class Variable	`rubrics`	Undocumented
Instance Variable	`at_deffnx`	Undocumented
Instance Variable	`at_item_x`	Undocumented
Instance Variable	`body`	Undocumented
Instance Variable	`colwidths`	Undocumented
Instance Variable	`context`	Undocumented
Instance Variable	`curfilestack`	Undocumented
Instance Variable	`desc_type_name`	Undocumented
Instance Variable	`descs`	Undocumented
Instance Variable	`elements`	Undocumented
Instance Variable	`entry_sep`	Undocumented
Instance Variable	`escape_hyphens`	Undocumented
Instance Variable	`escape_newlines`	Undocumented
Instance Variable	`first_param`	Undocumented
Instance Variable	`footnotestack`	Undocumented
Instance Variable	`fragment`	Undocumented
Instance Variable	`handled_abbrs`	Undocumented
Instance Variable	`in_footnote`	Undocumented
Instance Variable	`in_samp`	Undocumented
Instance Variable	`indices`	Undocumented
Instance Variable	`n_cols`	Undocumented
Instance Variable	`next_section_ids`	Undocumented
Instance Variable	`node_menus`	Undocumented
Instance Variable	`node_names`	Undocumented
Instance Variable	`output`	Undocumented
Instance Variable	`previous_section`	Undocumented
Instance Variable	`referenced_ids`	Undocumented
Instance Variable	`rellinks`	Undocumented
Instance Variable	`section_level`	Undocumented
Instance Variable	`seen_title`	Undocumented
Instance Variable	`short_ids`	Undocumented
Instance Variable	`written_ids`	Undocumented
Property	`desc`	Undocumented

Inherited from SphinxTranslator:

Method	`dispatch_departure`	Dispatch node to appropriate departure method. The priority of departure method is:
Method	`dispatch_visit`	Dispatch node to appropriate visitor method. The priority of visitor method is:
Method	`unknown_visit`	Undocumented
Instance Variable	`config`	Undocumented
Instance Variable	`settings`	Undocumented

def __init__(self, document, builder):

overrides sphinx.util.docutils.SphinxTranslator.__init__

Undocumented

Parameters
document:`nodes.document`	Undocumented
builder:`TexinfoBuilder`	Undocumented

def _visit_named_admonition(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def add_anchor(self, id, node):

Undocumented

Parameters
id:`str`	Undocumented
node:`Node`	Undocumented

def add_menu(self, node_name):

Undocumented

Parameters
node_name:`str`	Undocumented

def add_menu_entries(self, entries, reg=re.compile(r'\s+---?\s+')):

Undocumented

Parameters
entries:`List[str]`	Undocumented
reg:`Pattern`	Undocumented

def add_xref(self, id, name, node):

Undocumented

Parameters
id:`str`	Undocumented
name:`str`	Undocumented
node:`Node`	Undocumented

def collect_footnotes(self, node):

Undocumented

Parameters
node:`Element`	Undocumented
Returns
`Dict[str, List[Union[collected_footnote, bool]]]`	Undocumented

def collect_indices(self):

Undocumented

def collect_node_menus(self):

Collect the menu entries for each "node" section.

def collect_node_names(self):

Generates a unique id for each section.

Assigns the attribute node_name to each section.

def collect_rellinks(self):

Collect the relative links (next, previous, up) for each "node".

def depart_abbreviation(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_admonition(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_attribution(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_block_quote(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_bullet_list(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_caption(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_citation(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_citation_reference(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_classifier(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_collected_footnote(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_colspec(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_compound(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_container(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_decoration(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_definition(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_definition_list(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_definition_list_item(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_desc(self, node):

Undocumented

Parameters
node:`addnodes.desc`	Undocumented

def depart_desc_addname(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_desc_annotation(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_desc_content(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_desc_inline(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_desc_name(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_desc_optional(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_desc_parameterlist(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_desc_returns(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_desc_signature(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_desc_signature_line(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_desc_type(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_description(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_document(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_download_reference(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_emphasis(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_entry(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_enumerated_list(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_field(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_field_body(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_field_list(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_field_name(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_figure(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_glossary(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_hlist(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_hlistcol(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_image(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_inline(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_label(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_legend(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_line(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_line_block(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_list_item(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_literal(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_literal_block(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_literal_emphasis(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_literal_strong(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_manpage(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_option(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_option_argument(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_option_group(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_option_list(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_option_list_item(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_option_string(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_paragraph(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_pending_xref(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_problematic(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_production(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_reference(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_row(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_rubric(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_section(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_seealso(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_sidebar(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_start_of_file(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_strong(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_subscript(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_substitution_reference(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_subtitle(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_superscript(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_table(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_tabular_col_spec(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_target(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_tbody(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_term(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_Text(self, node):

Undocumented

Parameters
node:`Text`	Undocumented

def depart_tgroup(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_thead(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_title(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_topic(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_transition(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def depart_versionmodified(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def ensure_eol(self):

Ensure the last line in body is terminated by new line.

def escape(self, s):

Return a string with Texinfo command characters escaped.

Parameters
s:`str`	Undocumented
Returns
`str`	Undocumented

def escape_arg(self, s):

Return an escaped string suitable for use as an argument to a Texinfo command.

Parameters
s:`str`	Undocumented
Returns
`str`	Undocumented

def escape_id(self, s):

Return an escaped string suitable for node names and anchors.

Parameters
s:`str`	Undocumented
Returns
`str`	Undocumented

def escape_menu(self, s):

Return an escaped string suitable for menu entries.

Parameters
s:`str`	Undocumented
Returns
`str`	Undocumented

def finish(self):

Undocumented

def format_menu_entry(self, name, node_name, desc):

Undocumented

Parameters
name:`str`	Undocumented
node_name:`str`	Undocumented
desc:`str`	Undocumented
Returns
`str`	Undocumented

def get_short_id(self, id):

Return a shorter 'id' associated with id.

Parameters
id:`str`	Undocumented
Returns
`str`	Undocumented

def init_settings(self):

Undocumented

def is_samp(self, node):

Undocumented

Parameters
node:`Element`	Undocumented
Returns
`bool`	Undocumented

def tex_image_length(self, width_str):

Undocumented

Parameters
width_str:`str`	Undocumented
Returns
`str`	Undocumented

def unimplemented_visit(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def unknown_departure(self, node):

Undocumented

Parameters
node:`Node`	Undocumented

def visit_abbreviation(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_acks(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_admonition(self, node, name=''):

Undocumented

Parameters
node:`Element`	Undocumented
name:`str`	Undocumented

def visit_attribution(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_block_quote(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_bullet_list(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_caption(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_centered(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_citation(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_citation_reference(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_classifier(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_collected_footnote(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_colspec(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_comment(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_compound(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_container(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_decoration(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_definition(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_definition_list(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_definition_list_item(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_desc(self, node):

Undocumented

Parameters
node:`addnodes.desc`	Undocumented

def visit_desc_addname(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_desc_annotation(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_desc_content(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_desc_inline(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_desc_name(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_desc_optional(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_desc_parameter(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_desc_parameterlist(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_desc_returns(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_desc_signature(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_desc_signature_line(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_desc_type(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_description(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_docinfo(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_document(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_download_reference(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_emphasis(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_entry(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_enumerated_list(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_field(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_field_body(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_field_list(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_field_name(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_figure(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_footer(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_footnote(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_footnote_reference(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_generated(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_glossary(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_header(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_hlist(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_hlistcol(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_image(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_index(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_inline(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_label(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_legend(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_line(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_line_block(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_list_item(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_literal(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_literal_block(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_literal_emphasis(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_literal_strong(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_manpage(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_math(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_math_block(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_meta(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_number_reference(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_option(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_option_argument(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_option_group(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_option_list(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_option_list_item(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_option_string(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_paragraph(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_pending_xref(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_problematic(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_production(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_productionlist(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_raw(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_reference(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_row(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_rubric(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_section(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_seealso(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_sidebar(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_start_of_file(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_strong(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_subscript(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_substitution_definition(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_substitution_reference(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_subtitle(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_superscript(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_system_message(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_table(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_tabular_col_spec(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_target(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_tbody(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_term(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_Text(self, node):

Undocumented

Parameters
node:`Text`	Undocumented

def visit_tgroup(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_thead(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_title(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_title_reference(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_topic(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_transition(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

def visit_versionmodified(self, node):

Undocumented

Parameters
node:`Element`	Undocumented

builder: TexinfoBuilder =

overrides sphinx.util.docutils.SphinxTranslator.builder

Undocumented

default_elements: dict =

Undocumented

headings: tuple[str, ...] =

Undocumented

ignore_missing_images: bool =

Undocumented

rubrics: tuple[str, ...] =

Undocumented

at_deffnx: str =

Undocumented

at_item_x: str =

Undocumented

body: List[str] =

Undocumented

colwidths: list =

Undocumented

context: List[str] =

Undocumented

curfilestack: List[str] =

Undocumented

desc_type_name =

Undocumented

descs: List[addnodes.desc] =

Undocumented

elements =

Undocumented

entry_sep: str =

Undocumented

escape_hyphens: int =

Undocumented

escape_newlines: int =

Undocumented

first_param: int =

Undocumented

footnotestack: List[Dict[str, List[Union[collected_footnote, bool]]]] =

Undocumented

fragment =

Undocumented

handled_abbrs: Set[str] =

Undocumented

in_footnote: int =

Undocumented

in_samp: int =

Undocumented

indices =

Undocumented

n_cols =

Undocumented

next_section_ids: Set[str] =

Undocumented

node_menus: Dict[str, List[str]] =

Undocumented

node_names: Dict[str, str] =

Undocumented

output =

Undocumented

previous_section =

Undocumented

referenced_ids: Set[str] =

Undocumented

rellinks: Dict[str, List[str]] =

Undocumented

section_level: int =

Undocumented

seen_title: bool =

Undocumented

short_ids: Dict[str, str] =

Undocumented

written_ids: Set[str] =

Undocumented

@property
desc: Optional[addnodes.desc] =

Undocumented