docutils.writers.manpage.Translator

class documentation

class Translator(nodes.NodeVisitor):

View In Hierarchy

Method __init__ Undocumented
Method append​_header append header with .TH and .SH NAME
Method astext Return the final formatted document as a string.
Method comment Return commented version of the passed text.
Method comment​_begin Return commented version of the passed text WITHOUT end of line/comment.
Method dedent Undocumented
Method depart​_address Undocumented
Method depart​_admonition Undocumented
Method depart​_attribution Undocumented
Method depart​_authors Undocumented
Method depart​_block​_quote Undocumented
Method depart​_bullet​_list Undocumented
Method depart​_caption Undocumented
Method depart​_citation Undocumented
Method depart​_classifier 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​_description Undocumented
Method depart​_docinfo Undocumented
Method depart​_docinfo​_item Undocumented
Method depart​_doctest​_block Undocumented
Method depart​_document 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​_footer Undocumented
Method depart​_footnote Undocumented
Method depart​_footnote​_reference Undocumented
Method depart​_generated Undocumented
Method depart​_header 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​_math Undocumented
Method depart​_math​_block 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​_organization Undocumented
Method depart​_paragraph Undocumented
Method depart​_problematic Undocumented
Method depart​_reference Undocumented
Method depart​_row Undocumented
Method depart​_rubric Undocumented
Method depart​_section Undocumented
Method depart​_sidebar Undocumented
Method depart​_strong Undocumented
Method depart​_subscript Undocumented
Method depart​_subtitle Undocumented
Method depart​_superscript Undocumented
Method depart​_system​_message Undocumented
Method depart​_table 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​_title​_reference Undocumented
Method depart​_topic Undocumented
Method depart​_transition Undocumented
Method deunicode Undocumented
Method ensure​_eol Ensure the last line in body is terminated by new line.
Method first​_child Undocumented
Method footnote​_backrefs Undocumented
Method header Undocumented
Method indent Undocumented
Method list​_end Undocumented
Method list​_start Undocumented
Method unimplemented​_visit Undocumented
Method visit​_address Undocumented
Method visit​_admonition Undocumented
Method visit​_attention Undocumented
Method visit​_attribution Undocumented
Method visit​_author Undocumented
Method visit​_authors Undocumented
Method visit​_block​_quote Undocumented
Method visit​_bullet​_list Undocumented
Method visit​_caption Undocumented
Method visit​_caution Undocumented
Method visit​_citation Undocumented
Method visit​_citation​_reference Undocumented
Method visit​_classifier Undocumented
Method visit​_colspec Undocumented
Method visit​_comment Undocumented
Method visit​_compound Undocumented
Method visit​_contact Undocumented
Method visit​_container Undocumented
Method visit​_copyright Undocumented
Method visit​_danger Undocumented
Method visit​_date Undocumented
Method visit​_decoration Undocumented
Method visit​_definition Undocumented
Method visit​_definition​_list Undocumented
Method visit​_definition​_list​_item Undocumented
Method visit​_description Undocumented
Method visit​_docinfo Undocumented
Method visit​_docinfo​_item Undocumented
Method visit​_doctest​_block Undocumented
Method visit​_document Undocumented
Method visit​_emphasis Undocumented
Method visit​_entry Undocumented
Method visit​_enumerated​_list Undocumented
Method visit​_error 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​_header Undocumented
Method visit​_hint Undocumented
Method visit​_image Undocumented
Method visit​_important 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​_math Undocumented
Method visit​_math​_block Undocumented
Method visit​_note 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​_organization Undocumented
Method visit​_paragraph Undocumented
Method visit​_problematic Undocumented
Method visit​_raw Undocumented
Method visit​_reference E.g. link or email address.
Method visit​_revision Undocumented
Method visit​_row Undocumented
Method visit​_rubric Undocumented
Method visit​_section Undocumented
Method visit​_sidebar Undocumented
Method visit​_status Undocumented
Method visit​_strong Undocumented
Method visit​_subscript Undocumented
Method visit​_substitution​_definition Internal only.
Method visit​_substitution​_reference Undocumented
Method visit​_subtitle Undocumented
Method visit​_superscript Undocumented
Method visit​_system​_message Undocumented
Method visit​_table 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​_tip Undocumented
Method visit​_title Undocumented
Method visit​_title​_reference inline citation reference
Method visit​_topic Undocumented
Method visit​_transition Undocumented
Method visit​_version Undocumented
Method visit​_warning Undocumented
Method write​_colspecs Undocumented
Class Variable document​_start Undocumented
Class Variable possibly​_a​_roff​_command Undocumented
Class Variable words​_and​_spaces Undocumented
Instance Variable authors Undocumented
Instance Variable body Undocumented
Instance Variable colspecs Undocumented
Instance Variable compact​_p Undocumented
Instance Variable compact​_simple Undocumented
Instance Variable context Undocumented
Instance Variable defs Undocumented
Instance Variable foot Undocumented
Instance Variable head Undocumented
Instance Variable header​_written Undocumented
Instance Variable language Undocumented
Instance Variable section​_level Undocumented
Instance Variable settings Undocumented
Instance Variable topic​_class Undocumented
Instance Variable ​_active​_table Undocumented
Instance Variable ​_docinfo Undocumented
Instance Variable ​_docinfo​_keys Undocumented
Instance Variable ​_docinfo​_names Undocumented
Instance Variable ​_field​_name Undocumented
Instance Variable ​_in​_docinfo Undocumented
Instance Variable ​_in​_literal Undocumented
Instance Variable ​_indent Undocumented
Instance Variable ​_line​_block Undocumented
Instance Variable ​_list​_char Undocumented

Inherited from NodeVisitor:

Method dispatch​_departure Call self."depart_ + node class name" with node as parameter. If the depart_... method does not exist, call self.unknown_departure.
Method dispatch​_visit Call self."visit_ + node class name" with node as parameter. If the visit_... method does not exist, call self.unknown_visit.
Method unknown​_departure Called before exiting unknown Node types.
Method unknown​_visit Called when entering unknown Node types.
Class Variable optional Tuple containing node class names (as strings).
Instance Variable document Undocumented
def __init__(self, document):
overrides docutils.nodes.NodeVisitor.__init__

Undocumented

def append_header(self):
append header with .TH and .SH NAME
def astext(self):
Return the final formatted document as a string.
def comment(self, text):
Return commented version of the passed text.
def comment_begin(self, text):
Return commented version of the passed text WITHOUT end of line/comment.
def dedent(self):

Undocumented

def depart_address(self, node):

Undocumented

def depart_admonition(self, node):

Undocumented

def depart_attribution(self, node):

Undocumented

def depart_authors(self, node):

Undocumented

def depart_block_quote(self, node):

Undocumented

def depart_bullet_list(self, node):

Undocumented

def depart_caption(self, node):

Undocumented

def depart_citation(self, node):

Undocumented

def depart_classifier(self, node):

Undocumented

def depart_colspec(self, node):

Undocumented

def depart_compound(self, node):

Undocumented

def depart_container(self, node):

Undocumented

def depart_decoration(self, node):

Undocumented

def depart_definition(self, node):

Undocumented

def depart_definition_list(self, node):

Undocumented

def depart_definition_list_item(self, node):

Undocumented

def depart_description(self, node):

Undocumented

def depart_docinfo(self, node):

Undocumented

def depart_docinfo_item(self, node):

Undocumented

def depart_doctest_block(self, node):

Undocumented

def depart_document(self, node):

Undocumented

def depart_emphasis(self, node):

Undocumented

def depart_entry(self, node):

Undocumented

def depart_enumerated_list(self, node):

Undocumented

def depart_field(self, node):

Undocumented

def depart_field_body(self, node):

Undocumented

def depart_field_list(self, node):

Undocumented

def depart_field_name(self, node):

Undocumented

def depart_figure(self, node):

Undocumented

def depart_footer(self, node):

Undocumented

def depart_footnote(self, node):

Undocumented

def depart_footnote_reference(self, node):

Undocumented

def depart_generated(self, node):

Undocumented

def depart_header(self, node):

Undocumented

def depart_inline(self, node):

Undocumented

def depart_label(self, node):

Undocumented

def depart_legend(self, node):

Undocumented

def depart_line(self, node):

Undocumented

def depart_line_block(self, node):

Undocumented

def depart_list_item(self, node):

Undocumented

def depart_literal(self, node):

Undocumented

def depart_literal_block(self, node):

Undocumented

def depart_math(self, node):

Undocumented

def depart_math_block(self, node):

Undocumented

def depart_option(self, node):

Undocumented

def depart_option_argument(self, node):

Undocumented

def depart_option_group(self, node):

Undocumented

def depart_option_list(self, node):

Undocumented

def depart_option_list_item(self, node):

Undocumented

def depart_option_string(self, node):

Undocumented

def depart_organization(self, node):

Undocumented

def depart_paragraph(self, node):

Undocumented

def depart_problematic(self, node):

Undocumented

def depart_reference(self, node):

Undocumented

def depart_row(self, node):

Undocumented

def depart_rubric(self, node):

Undocumented

def depart_section(self, node):

Undocumented

def depart_sidebar(self, node):

Undocumented

def depart_strong(self, node):

Undocumented

def depart_subscript(self, node):

Undocumented

def depart_subtitle(self, node):

Undocumented

def depart_superscript(self, node):

Undocumented

def depart_system_message(self, node):

Undocumented

def depart_table(self, node):

Undocumented

def depart_tbody(self, node):

Undocumented

def depart_term(self, node):

Undocumented

def depart_Text(self, node):

Undocumented

def depart_tgroup(self, node):

Undocumented

def depart_thead(self, node):

Undocumented

def depart_title(self, node):

Undocumented

def depart_title_reference(self, node):

Undocumented

def depart_topic(self, node):

Undocumented

def depart_transition(self, node):

Undocumented

def deunicode(self, text):

Undocumented

def ensure_eol(self):
Ensure the last line in body is terminated by new line.
def first_child(self, node):

Undocumented

def footnote_backrefs(self, node):

Undocumented

def header(self):

Undocumented

def indent(self, by=0.5):

Undocumented

def list_end(self):

Undocumented

def list_start(self, node):

Undocumented

def unimplemented_visit(self, node):

Undocumented

def visit_address(self, node):

Undocumented

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

Undocumented

def visit_attention(self, node):

Undocumented

def visit_attribution(self, node):

Undocumented

def visit_author(self, node):

Undocumented

def visit_authors(self, node):

Undocumented

def visit_block_quote(self, node):

Undocumented

def visit_bullet_list(self, node):

Undocumented

def visit_caption(self, node):

Undocumented

def visit_caution(self, node):

Undocumented

def visit_citation(self, node):

Undocumented

def visit_citation_reference(self, node):

Undocumented

def visit_classifier(self, node):

Undocumented

def visit_colspec(self, node):

Undocumented

def visit_comment(self, node, sub=re.compile('-(?=-)').sub):

Undocumented

def visit_compound(self, node):

Undocumented

def visit_contact(self, node):

Undocumented

def visit_container(self, node):

Undocumented

def visit_copyright(self, node):

Undocumented

def visit_danger(self, node):

Undocumented

def visit_date(self, node):

Undocumented

def visit_decoration(self, node):

Undocumented

def visit_definition(self, node):

Undocumented

def visit_definition_list(self, node):

Undocumented

def visit_definition_list_item(self, node):

Undocumented

def visit_description(self, node):

Undocumented

def visit_docinfo(self, node):

Undocumented

def visit_docinfo_item(self, node, name):

Undocumented

def visit_doctest_block(self, node):

Undocumented

def visit_document(self, node):

Undocumented

def visit_emphasis(self, node):

Undocumented

def visit_entry(self, node):

Undocumented

def visit_enumerated_list(self, node):

Undocumented

def visit_error(self, node):

Undocumented

def visit_field(self, node):

Undocumented

def visit_field_body(self, node):

Undocumented

def visit_field_list(self, node):

Undocumented

def visit_field_name(self, node):

Undocumented

def visit_figure(self, node):

Undocumented

def visit_footer(self, node):

Undocumented

def visit_footnote(self, node):

Undocumented

def visit_footnote_reference(self, node):

Undocumented

def visit_generated(self, node):

Undocumented

def visit_header(self, node):

Undocumented

def visit_hint(self, node):

Undocumented

def visit_image(self, node):

Undocumented

def visit_important(self, node):

Undocumented

def visit_inline(self, node):

Undocumented

def visit_label(self, node):

Undocumented

def visit_legend(self, node):

Undocumented

def visit_line(self, node):

Undocumented

def visit_line_block(self, node):

Undocumented

def visit_list_item(self, node):

Undocumented

def visit_literal(self, node):

Undocumented

def visit_literal_block(self, node):

Undocumented

def visit_math(self, node):

Undocumented

def visit_math_block(self, node):

Undocumented

def visit_note(self, node):

Undocumented

def visit_option(self, node):

Undocumented

def visit_option_argument(self, node):

Undocumented

def visit_option_group(self, node):

Undocumented

def visit_option_list(self, node):

Undocumented

def visit_option_list_item(self, node):

Undocumented

def visit_option_string(self, node):

Undocumented

def visit_organization(self, node):

Undocumented

def visit_paragraph(self, node):

Undocumented

def visit_problematic(self, node):

Undocumented

def visit_raw(self, node):

Undocumented

def visit_reference(self, node):
E.g. link or email address.
def visit_revision(self, node):

Undocumented

def visit_row(self, node):

Undocumented

def visit_rubric(self, node):

Undocumented

def visit_section(self, node):

Undocumented

def visit_sidebar(self, node):

Undocumented

def visit_status(self, node):

Undocumented

def visit_strong(self, node):

Undocumented

def visit_subscript(self, node):

Undocumented

def visit_substitution_definition(self, node):
Internal only.
def visit_substitution_reference(self, node):

Undocumented

def visit_subtitle(self, node):

Undocumented

def visit_superscript(self, node):

Undocumented

def visit_system_message(self, node):

Undocumented

def visit_table(self, node):

Undocumented

def visit_target(self, node):

Undocumented

def visit_tbody(self, node):

Undocumented

def visit_term(self, node):

Undocumented

def visit_Text(self, node):

Undocumented

def visit_tgroup(self, node):

Undocumented

def visit_thead(self, node):

Undocumented

def visit_tip(self, node):

Undocumented

def visit_title(self, node):

Undocumented

def visit_title_reference(self, node):
inline citation reference
def visit_topic(self, node):

Undocumented

def visit_transition(self, node):

Undocumented

def visit_version(self, node):

Undocumented

def visit_warning(self, node):

Undocumented

def write_colspecs(self):

Undocumented

document_start: str =

Undocumented

possibly_a_roff_command =

Undocumented

words_and_spaces =

Undocumented

authors: list =

Undocumented

body: list =

Undocumented

colspecs: list =

Undocumented

compact_p: int =

Undocumented

compact_simple =

Undocumented

context: list =

Undocumented

defs: dict =

Undocumented

foot: list =

Undocumented

head: list =

Undocumented

header_written: int =

Undocumented

language =

Undocumented

section_level: int =

Undocumented

settings =

Undocumented

topic_class: str =

Undocumented

_active_table =

Undocumented

_docinfo: dict =

Undocumented

_docinfo_keys: list =

Undocumented

_docinfo_names: dict =

Undocumented

_field_name =

Undocumented

_in_docinfo =

Undocumented

_in_literal: bool =

Undocumented

_indent: list[int] =

Undocumented

_line_block: int =

Undocumented

_list_char: list =

Undocumented