sphinx.writers.manpage.ManualPageTranslator

class documentation

class ManualPageTranslator(SphinxTranslator, BaseTranslator): (source)

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
Instance Variable first_param Undocumented
Instance Variable in_productionlist Undocumented
Instance Variable section_level Undocumented
Class Variable _docinfo 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): (source)
overrides sphinx.util.docutils.SphinxTranslator.__init__

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
def header(self): (source)

Undocumented

Returns
strUndocumented
def visit_abbreviation(self, node): (source)

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
first_param: int = (source)

Undocumented

in_productionlist: int = (source)

Undocumented

section_level: int = (source)

Undocumented

_docinfo: dict[str, Any] = (source)

Undocumented