Qucs-S S-parameter Viewer & RF Synthesis Tools
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Protected Attributes | List of all members
docutils.writers.manpage.Translator Class Reference
Inheritance diagram for docutils.writers.manpage.Translator:
Inheritance graph
[legend]
Collaboration diagram for docutils.writers.manpage.Translator:
Collaboration graph
[legend]

Public Member Functions

 __init__ (self, document)
 
 comment_begin (self, text)
 
 comment (self, text)
 
 ensure_eol (self)
 
 astext (self)
 
 deunicode (self, text)
 
 visit_Text (self, node)
 
 depart_Text (self, node)
 
 list_start (self, node)
 
 list_end (self)
 
 header (self)
 
 append_header (self)
 
 visit_address (self, node)
 
 depart_address (self, node)
 
 visit_admonition (self, node, name=None)
 
 depart_admonition (self, node)
 
 visit_attention (self, node)
 
 visit_docinfo_item (self, node, name)
 
 depart_docinfo_item (self, node)
 
 visit_author (self, node)
 
 visit_authors (self, node)
 
 depart_authors (self, node)
 
 visit_block_quote (self, node)
 
 depart_block_quote (self, node)
 
 visit_bullet_list (self, node)
 
 depart_bullet_list (self, node)
 
 visit_caption (self, node)
 
 depart_caption (self, node)
 
 visit_caution (self, node)
 
 visit_citation (self, node)
 
 depart_citation (self, node)
 
 visit_citation_reference (self, node)
 
 visit_classifier (self, node)
 
 depart_classifier (self, node)
 
 visit_colspec (self, node)
 
 depart_colspec (self, node)
 
 write_colspecs (self)
 
 visit_comment (self, node, sub=re.compile('-(?=-)').sub)
 
 visit_contact (self, node)
 
 visit_container (self, node)
 
 depart_container (self, node)
 
 visit_compound (self, node)
 
 depart_compound (self, node)
 
 visit_copyright (self, node)
 
 visit_danger (self, node)
 
 visit_date (self, node)
 
 visit_decoration (self, node)
 
 depart_decoration (self, node)
 
 visit_definition (self, node)
 
 depart_definition (self, node)
 
 visit_definition_list (self, node)
 
 depart_definition_list (self, node)
 
 visit_definition_list_item (self, node)
 
 depart_definition_list_item (self, node)
 
 visit_description (self, node)
 
 depart_description (self, node)
 
 visit_docinfo (self, node)
 
 depart_docinfo (self, node)
 
 visit_doctest_block (self, node)
 
 depart_doctest_block (self, node)
 
 visit_document (self, node)
 
 depart_document (self, node)
 
 visit_emphasis (self, node)
 
 depart_emphasis (self, node)
 
 visit_entry (self, node)
 
 depart_entry (self, node)
 
 visit_enumerated_list (self, node)
 
 depart_enumerated_list (self, node)
 
 visit_error (self, node)
 
 visit_field (self, node)
 
 depart_field (self, node)
 
 visit_field_body (self, node)
 
 depart_field_body (self, node)
 
 visit_field_list (self, node)
 
 depart_field_list (self, node)
 
 visit_field_name (self, node)
 
 depart_field_name (self, node)
 
 visit_figure (self, node)
 
 depart_figure (self, node)
 
 visit_footer (self, node)
 
 depart_footer (self, node)
 
 visit_footnote (self, node)
 
 depart_footnote (self, node)
 
 footnote_backrefs (self, node)
 
 visit_footnote_reference (self, node)
 
 depart_footnote_reference (self, node)
 
 visit_generated (self, node)
 
 depart_generated (self, node)
 
 visit_header (self, node)
 
 depart_header (self, node)
 
 visit_hint (self, node)
 
 visit_subscript (self, node)
 
 depart_subscript (self, node)
 
 visit_superscript (self, node)
 
 depart_superscript (self, node)
 
 visit_attribution (self, node)
 
 depart_attribution (self, node)
 
 visit_image (self, node)
 
 visit_important (self, node)
 
 visit_inline (self, node)
 
 depart_inline (self, node)
 
 visit_label (self, node)
 
 depart_label (self, node)
 
 visit_legend (self, node)
 
 depart_legend (self, node)
 
 visit_line_block (self, node)
 
 depart_line_block (self, node)
 
 visit_line (self, node)
 
 depart_line (self, node)
 
 visit_list_item (self, node)
 
 depart_list_item (self, node)
 
 visit_literal (self, node)
 
 depart_literal (self, node)
 
 visit_literal_block (self, node)
 
 depart_literal_block (self, node)
 
 visit_math (self, node)
 
 depart_math (self, node)
 
 visit_math_block (self, node)
 
 depart_math_block (self, node)
 
 visit_note (self, node)
 
 indent (self, by=0.5)
 
 dedent (self)
 
 visit_option_list (self, node)
 
 depart_option_list (self, node)
 
 visit_option_list_item (self, node)
 
 depart_option_list_item (self, node)
 
 visit_option_group (self, node)
 
 depart_option_group (self, node)
 
 visit_option (self, node)
 
 depart_option (self, node)
 
 visit_option_string (self, node)
 
 depart_option_string (self, node)
 
 visit_option_argument (self, node)
 
 depart_option_argument (self, node)
 
 visit_organization (self, node)
 
 depart_organization (self, node)
 
 first_child (self, node)
 
 visit_paragraph (self, node)
 
 depart_paragraph (self, node)
 
 visit_problematic (self, node)
 
 depart_problematic (self, node)
 
 visit_raw (self, node)
 
 visit_reference (self, node)
 
 depart_reference (self, node)
 
 visit_revision (self, node)
 
 visit_row (self, node)
 
 depart_row (self, node)
 
 visit_section (self, node)
 
 depart_section (self, node)
 
 visit_status (self, node)
 
 visit_strong (self, node)
 
 depart_strong (self, node)
 
 visit_substitution_definition (self, node)
 
 visit_substitution_reference (self, node)
 
 visit_subtitle (self, node)
 
 depart_subtitle (self, node)
 
 visit_system_message (self, node)
 
 depart_system_message (self, node)
 
 visit_table (self, node)
 
 depart_table (self, node)
 
 visit_target (self, node)
 
 visit_tbody (self, node)
 
 depart_tbody (self, node)
 
 visit_term (self, node)
 
 depart_term (self, node)
 
 visit_tgroup (self, node)
 
 depart_tgroup (self, node)
 
 visit_thead (self, node)
 
 depart_thead (self, node)
 
 visit_tip (self, node)
 
 visit_title (self, node)
 
 depart_title (self, node)
 
 visit_title_reference (self, node)
 
 depart_title_reference (self, node)
 
 visit_topic (self, node)
 
 depart_topic (self, node)
 
 visit_sidebar (self, node)
 
 depart_sidebar (self, node)
 
 visit_rubric (self, node)
 
 depart_rubric (self, node)
 
 visit_transition (self, node)
 
 depart_transition (self, node)
 
 visit_version (self, node)
 
 visit_warning (self, node)
 
 unimplemented_visit (self, node)
 
- Public Member Functions inherited from docutils.nodes.NodeVisitor
 dispatch_visit (self, node)
 
 dispatch_departure (self, node)
 
 unknown_visit (self, node)
 
 unknown_departure (self, node)
 

Public Attributes

 settings
 
 language
 
 head
 
 body
 
 foot
 
 section_level
 
 context
 
 topic_class
 
 colspecs
 
 compact_p
 
 compact_simple
 
 header_written
 
 authors
 
 defs
 
 document_start
 
- Public Attributes inherited from docutils.nodes.NodeVisitor
 document
 
 optional
 

Static Public Attributes

 words_and_spaces = re.compile(r'\S+| +|\n')
 
 possibly_a_roff_command = re.compile(r'\.\w')
 
str document_start = """Man page generated from reStructuredText."""
 
 depart_attention = depart_admonition
 
 depart_author = depart_docinfo_item
 
 depart_caution = depart_admonition
 
 depart_contact = depart_docinfo_item
 
 depart_danger = depart_admonition
 
 depart_error = depart_admonition
 
 depart_hint = depart_admonition
 
 depart_important = depart_admonition
 
 depart_note = depart_admonition
 
 depart_revision = depart_docinfo_item
 
 depart_status = depart_docinfo_item
 
 depart_tip = depart_admonition
 
 depart_warning = depart_admonition
 
- Static Public Attributes inherited from docutils.nodes.NodeVisitor
tuple optional = ('meta',)
 

Protected Attributes

 _list_char
 
 _docinfo
 
 _docinfo_keys
 
 _docinfo_names
 
 _in_docinfo
 
 _field_name
 
 _active_table
 
 _has_a_table
 
 _in_literal
 
 _line_block
 
 _indent
 
 _style
 
 _cnt
 

Constructor & Destructor Documentation

◆ __init__()

docutils.writers.manpage.Translator.__init__ (   self,
  document 
)

Reimplemented from docutils.nodes.NodeVisitor.

Member Function Documentation

◆ append_header()

docutils.writers.manpage.Translator.append_header (   self)
append header with .TH and .SH NAME

◆ astext()

docutils.writers.manpage.Translator.astext (   self)
Return the final formatted document as a string.

◆ comment()

docutils.writers.manpage.Translator.comment (   self,
  text 
)
Return commented version of the passed text.

◆ comment_begin()

docutils.writers.manpage.Translator.comment_begin (   self,
  text 
)
Return commented version of the passed text WITHOUT end of
line/comment.

◆ ensure_eol()

docutils.writers.manpage.Translator.ensure_eol (   self)
Ensure the last line in body is terminated by new line.

◆ visit_reference()

docutils.writers.manpage.Translator.visit_reference (   self,
  node 
)
E.g. link or email address.

◆ visit_substitution_definition()

docutils.writers.manpage.Translator.visit_substitution_definition (   self,
  node 
)
Internal only.

◆ visit_title_reference()

docutils.writers.manpage.Translator.visit_title_reference (   self,
  node 
)
inline citation reference

The documentation for this class was generated from the following file: