docutils.writers.manpage.Translator

class documentation

class Translator(nodes.NodeVisitor): (source)

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): (source)
overrides docutils.nodes.NodeVisitor.__init__

Undocumented

def append_header(self): (source)

append header with .TH and .SH NAME

def astext(self): (source)

Return the final formatted document as a string.

def comment(self, text): (source)

Return commented version of the passed text.

def comment_begin(self, text): (source)

Return commented version of the passed text WITHOUT end of line/comment.

def dedent(self): (source)

Undocumented

def depart_address(self, node): (source)

Undocumented

def depart_admonition(self, node): (source)

Undocumented

def depart_attribution(self, node): (source)

Undocumented

def depart_authors(self, node): (source)

Undocumented

def depart_block_quote(self, node): (source)

Undocumented

def depart_bullet_list(self, node): (source)

Undocumented

def depart_caption(self, node): (source)

Undocumented

def depart_citation(self, node): (source)

Undocumented

def depart_classifier(self, node): (source)

Undocumented

def depart_colspec(self, node): (source)

Undocumented

def depart_compound(self, node): (source)

Undocumented

def depart_container(self, node): (source)

Undocumented

def depart_decoration(self, node): (source)

Undocumented

def depart_definition(self, node): (source)

Undocumented

def depart_definition_list(self, node): (source)

Undocumented

def depart_definition_list_item(self, node): (source)

Undocumented

def depart_description(self, node): (source)

Undocumented

def depart_docinfo(self, node): (source)

Undocumented

def depart_docinfo_item(self, node): (source)

Undocumented

def depart_doctest_block(self, node): (source)

Undocumented

def depart_document(self, node): (source)

Undocumented

def depart_emphasis(self, node): (source)

Undocumented

def depart_entry(self, node): (source)

Undocumented

def depart_enumerated_list(self, node): (source)

Undocumented

def depart_field(self, node): (source)

Undocumented

def depart_field_body(self, node): (source)

Undocumented

def depart_field_list(self, node): (source)

Undocumented

def depart_field_name(self, node): (source)

Undocumented

def depart_figure(self, node): (source)

Undocumented

def depart_footer(self, node): (source)

Undocumented

def depart_footnote(self, node): (source)

Undocumented

def depart_footnote_reference(self, node): (source)

Undocumented

def depart_generated(self, node): (source)

Undocumented

def depart_header(self, node): (source)

Undocumented

def depart_inline(self, node): (source)

Undocumented

def depart_label(self, node): (source)

Undocumented

def depart_legend(self, node): (source)

Undocumented

def depart_line(self, node): (source)

Undocumented

def depart_line_block(self, node): (source)

Undocumented

def depart_list_item(self, node): (source)

Undocumented

def depart_literal(self, node): (source)

Undocumented

def depart_literal_block(self, node): (source)

Undocumented

def depart_math(self, node): (source)

Undocumented

def depart_math_block(self, node): (source)

Undocumented

def depart_option(self, node): (source)

Undocumented

def depart_option_argument(self, node): (source)

Undocumented

def depart_option_group(self, node): (source)

Undocumented

def depart_option_list(self, node): (source)

Undocumented

def depart_option_list_item(self, node): (source)

Undocumented

def depart_option_string(self, node): (source)

Undocumented

def depart_organization(self, node): (source)

Undocumented

def depart_paragraph(self, node): (source)

Undocumented

def depart_problematic(self, node): (source)

Undocumented

def depart_reference(self, node): (source)

Undocumented

def depart_row(self, node): (source)

Undocumented

def depart_rubric(self, node): (source)

Undocumented

def depart_section(self, node): (source)

Undocumented

def depart_sidebar(self, node): (source)

Undocumented

def depart_strong(self, node): (source)

Undocumented

def depart_subscript(self, node): (source)

Undocumented

def depart_subtitle(self, node): (source)

Undocumented

def depart_superscript(self, node): (source)

Undocumented

def depart_system_message(self, node): (source)

Undocumented

def depart_table(self, node): (source)

Undocumented

def depart_tbody(self, node): (source)

Undocumented

def depart_term(self, node): (source)

Undocumented

def depart_Text(self, node): (source)

Undocumented

def depart_tgroup(self, node): (source)

Undocumented

def depart_thead(self, node): (source)

Undocumented

def depart_title(self, node): (source)

Undocumented

def depart_title_reference(self, node): (source)

Undocumented

def depart_topic(self, node): (source)

Undocumented

def depart_transition(self, node): (source)

Undocumented

def deunicode(self, text): (source)

Undocumented

def ensure_eol(self): (source)

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

def first_child(self, node): (source)

Undocumented

def footnote_backrefs(self, node): (source)

Undocumented

def header(self): (source)

Undocumented

def indent(self, by=0.5): (source)

Undocumented

def list_end(self): (source)

Undocumented

def list_start(self, node): (source)

Undocumented

def unimplemented_visit(self, node): (source)

Undocumented

def visit_address(self, node): (source)

Undocumented

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

Undocumented

def visit_attention(self, node): (source)

Undocumented

def visit_attribution(self, node): (source)

Undocumented

def visit_author(self, node): (source)

Undocumented

def visit_authors(self, node): (source)

Undocumented

def visit_block_quote(self, node): (source)

Undocumented

def visit_bullet_list(self, node): (source)

Undocumented

def visit_caption(self, node): (source)

Undocumented

def visit_caution(self, node): (source)

Undocumented

def visit_citation(self, node): (source)

Undocumented

def visit_citation_reference(self, node): (source)

Undocumented

def visit_classifier(self, node): (source)

Undocumented

def visit_colspec(self, node): (source)

Undocumented

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

Undocumented

def visit_compound(self, node): (source)

Undocumented

def visit_contact(self, node): (source)

Undocumented

def visit_container(self, node): (source)

Undocumented

def visit_copyright(self, node): (source)

Undocumented

def visit_danger(self, node): (source)

Undocumented

def visit_date(self, node): (source)

Undocumented

def visit_decoration(self, node): (source)

Undocumented

def visit_definition(self, node): (source)

Undocumented

def visit_definition_list(self, node): (source)

Undocumented

def visit_definition_list_item(self, node): (source)

Undocumented

def visit_description(self, node): (source)

Undocumented

def visit_docinfo(self, node): (source)

Undocumented

def visit_docinfo_item(self, node, name): (source)

Undocumented

def visit_doctest_block(self, node): (source)

Undocumented

def visit_document(self, node): (source)

Undocumented

def visit_emphasis(self, node): (source)

Undocumented

def visit_entry(self, node): (source)

Undocumented

def visit_enumerated_list(self, node): (source)

Undocumented

def visit_error(self, node): (source)

Undocumented

def visit_field(self, node): (source)

Undocumented

def visit_field_body(self, node): (source)

Undocumented

def visit_field_list(self, node): (source)

Undocumented

def visit_field_name(self, node): (source)

Undocumented

def visit_figure(self, node): (source)

Undocumented

def visit_footer(self, node): (source)

Undocumented

def visit_footnote(self, node): (source)

Undocumented

def visit_footnote_reference(self, node): (source)

Undocumented

def visit_generated(self, node): (source)

Undocumented

def visit_header(self, node): (source)

Undocumented

def visit_hint(self, node): (source)

Undocumented

def visit_image(self, node): (source)

Undocumented

def visit_important(self, node): (source)

Undocumented

def visit_inline(self, node): (source)

Undocumented

def visit_label(self, node): (source)

Undocumented

def visit_legend(self, node): (source)

Undocumented

def visit_line(self, node): (source)

Undocumented

def visit_line_block(self, node): (source)

Undocumented

def visit_list_item(self, node): (source)

Undocumented

def visit_literal(self, node): (source)

Undocumented

def visit_literal_block(self, node): (source)

Undocumented

def visit_math(self, node): (source)

Undocumented

def visit_math_block(self, node): (source)

Undocumented

def visit_note(self, node): (source)

Undocumented

def visit_option(self, node): (source)

Undocumented

def visit_option_argument(self, node): (source)

Undocumented

def visit_option_group(self, node): (source)

Undocumented

def visit_option_list(self, node): (source)

Undocumented

def visit_option_list_item(self, node): (source)

Undocumented

def visit_option_string(self, node): (source)

Undocumented

def visit_organization(self, node): (source)

Undocumented

def visit_paragraph(self, node): (source)

Undocumented

def visit_problematic(self, node): (source)

Undocumented

def visit_raw(self, node): (source)

Undocumented

def visit_reference(self, node): (source)

E.g. link or email address.

def visit_revision(self, node): (source)

Undocumented

def visit_row(self, node): (source)

Undocumented

def visit_rubric(self, node): (source)

Undocumented

def visit_section(self, node): (source)

Undocumented

def visit_sidebar(self, node): (source)

Undocumented

def visit_status(self, node): (source)

Undocumented

def visit_strong(self, node): (source)

Undocumented

def visit_subscript(self, node): (source)

Undocumented

def visit_substitution_definition(self, node): (source)

Internal only.

def visit_substitution_reference(self, node): (source)

Undocumented

def visit_subtitle(self, node): (source)

Undocumented

def visit_superscript(self, node): (source)

Undocumented

def visit_system_message(self, node): (source)

Undocumented

def visit_table(self, node): (source)

Undocumented

def visit_target(self, node): (source)

Undocumented

def visit_tbody(self, node): (source)

Undocumented

def visit_term(self, node): (source)

Undocumented

def visit_Text(self, node): (source)

Undocumented

def visit_tgroup(self, node): (source)

Undocumented

def visit_thead(self, node): (source)

Undocumented

def visit_tip(self, node): (source)

Undocumented

def visit_title(self, node): (source)

Undocumented

def visit_title_reference(self, node): (source)

inline citation reference

def visit_topic(self, node): (source)

Undocumented

def visit_transition(self, node): (source)

Undocumented

def visit_version(self, node): (source)

Undocumented

def visit_warning(self, node): (source)

Undocumented

def write_colspecs(self): (source)

Undocumented

document_start: str = (source)

Undocumented

possibly_a_roff_command = (source)

Undocumented

words_and_spaces = (source)

Undocumented

authors: list = (source)

Undocumented

body: list = (source)

Undocumented

colspecs: list = (source)

Undocumented

compact_p: int = (source)

Undocumented

compact_simple = (source)

Undocumented

context: list = (source)

Undocumented

defs: dict = (source)

Undocumented

foot: list = (source)

Undocumented

head: list = (source)

Undocumented

header_written: int = (source)

Undocumented

language = (source)

Undocumented

section_level: int = (source)

Undocumented

settings = (source)

Undocumented

topic_class: str = (source)

Undocumented

_active_table = (source)

Undocumented

_docinfo: dict = (source)

Undocumented

_docinfo_keys: list = (source)

Undocumented

_docinfo_names: dict = (source)

Undocumented

_field_name = (source)

Undocumented

_in_docinfo = (source)

Undocumented

_in_literal: bool = (source)

Undocumented

_indent: list[int] = (source)

Undocumented

_line_block: int = (source)

Undocumented

_list_char: list = (source)

Undocumented