sphinx.writers.manpage.ManualPageTranslator

class documentation

class ManualPageTranslator(SphinxTranslator, BaseTranslator):

View In Hierarchy

Custom man page translator.
Method __init__ Undocumented
Method depart​_abbreviation Undocumented
Method depart​_caption Undocumented
Method depart​_centered Undocumented
Method depart​_compact​_paragraph 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​_parameter 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​_download​_reference Undocumented
Method depart​_glossary Undocumented
Method depart​_hlist Undocumented
Method depart​_hlistcol Undocumented
Method depart​_inline Undocumented
Method depart​_literal​_emphasis Undocumented
Method depart​_literal​_strong Undocumented
Method depart​_manpage Undocumented
Method depart​_math Undocumented
Method depart​_math​_block Undocumented
Method depart​_production Undocumented
Method depart​_rubric Undocumented
Method depart​_seealso Undocumented
Method depart​_start​_of​_file Undocumented
Method depart​_title Undocumented
Method depart​_versionmodified Undocumented
Method header Undocumented
Method visit​_abbreviation Undocumented
Method visit​_acks Undocumented
Method visit​_caption Undocumented
Method visit​_centered Undocumented
Method visit​_comment Undocumented
Method visit​_compact​_paragraph 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​_download​_reference Undocumented
Method visit​_footnote Undocumented
Method visit​_glossary Undocumented
Method visit​_hlist Undocumented
Method visit​_hlistcol Undocumented
Method visit​_image Undocumented
Method visit​_index Undocumented
Method visit​_inline 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​_production Undocumented
Method visit​_productionlist Undocumented
Method visit​_raw Undocumented
Method visit​_reference Undocumented
Method visit​_rubric Undocumented
Method visit​_seealso Undocumented
Method visit​_start​_of​_file Undocumented
Method visit​_tabular​_col​_spec Undocumented
Method visit​_term Undocumented
Method visit​_title Undocumented
Method visit​_toctree Undocumented
Method visit​_versionmodified Undocumented
Class Variable ​_docinfo Undocumented
Instance Variable first​_param Undocumented
Instance Variable in​_productionlist Undocumented
Instance Variable section​_level 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 builder Undocumented
Instance Variable config Undocumented
Instance Variable settings Undocumented
def __init__(self, document, builder):
overrides sphinx.util.docutils.SphinxTranslator.__init__

Undocumented

Parameters
document:nodes.documentUndocumented
builder:BuilderUndocumented
def depart_abbreviation(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_caption(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_centered(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_compact_paragraph(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_desc(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_desc_addname(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_desc_annotation(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_desc_content(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_desc_inline(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_desc_name(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_desc_optional(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_desc_parameter(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_desc_parameterlist(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_desc_returns(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_desc_signature(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_desc_signature_line(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_desc_type(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_download_reference(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_glossary(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_hlist(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_hlistcol(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_inline(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_literal_emphasis(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_literal_strong(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_manpage(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_math(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_math_block(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_production(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_rubric(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_seealso(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_start_of_file(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_title(self, node):

Undocumented

Parameters
node:ElementUndocumented
def depart_versionmodified(self, node):

Undocumented

Parameters
node:ElementUndocumented
def header(self):

Undocumented

Returns
strUndocumented
def visit_abbreviation(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_acks(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_caption(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_centered(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_comment(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_compact_paragraph(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_desc(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_desc_addname(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_desc_annotation(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_desc_content(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_desc_inline(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_desc_name(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_desc_optional(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_desc_parameter(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_desc_parameterlist(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_desc_returns(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_desc_signature(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_desc_signature_line(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_desc_type(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_download_reference(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_footnote(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_glossary(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_hlist(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_hlistcol(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_image(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_index(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_inline(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_literal_emphasis(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_literal_strong(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_manpage(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_math(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_math_block(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_meta(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_number_reference(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_production(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_productionlist(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_raw(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_reference(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_rubric(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_seealso(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_start_of_file(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_tabular_col_spec(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_term(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_title(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_toctree(self, node):

Undocumented

Parameters
node:ElementUndocumented
def visit_versionmodified(self, node):

Undocumented

Parameters
node:ElementUndocumented
_docinfo: Dict[str, Any] =

Undocumented

first_param: int =

Undocumented

in_productionlist: int =

Undocumented

section_level: int =

Undocumented