sphinx.writers.html5.HTML5Translator

class documentation

class HTML5Translator(SphinxTranslator, BaseTranslator): (source)

View In Hierarchy

Our custom HTML translator.

Method __init__ Undocumented
Method add_fignumber Undocumented
Method add_permalink_ref Undocumented
Method add_secnumber Undocumented
Method depart_abbreviation Undocumented
Method depart_acks Undocumented
Method depart_admonition Undocumented
Method depart_attention Undocumented
Method depart_block_quote Undocumented
Method depart_caption Undocumented
Method depart_caution Undocumented
Method depart_centered Undocumented
Method depart_classifier Undocumented
Method depart_compact_paragraph Undocumented
Method depart_danger Undocumented
Method depart_definition 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_error Undocumented
Method depart_field_list Undocumented
Method depart_glossary Undocumented
Method depart_hint Undocumented
Method depart_hlist Undocumented
Method depart_hlistcol Undocumented
Method depart_image Undocumented
Method depart_important Undocumented
Method depart_literal 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_note Undocumented
Method depart_number_reference Undocumented
Method depart_production Undocumented
Method depart_productionlist Undocumented
Method depart_seealso Undocumented
Method depart_start_of_file Undocumented
Method depart_table Undocumented
Method depart_term Undocumented
Method depart_tip Undocumented
Method depart_title Undocumented
Method depart_versionmodified Undocumented
Method depart_warning Undocumented
Method get_secnumber Undocumented
Method visit_abbreviation Undocumented
Method visit_acks Undocumented
Method visit_admonition Undocumented
Method visit_attention Undocumented
Method visit_block_quote Undocumented
Method visit_bullet_list Undocumented
Method visit_caption Undocumented
Method visit_caution Undocumented
Method visit_centered Undocumented
Method visit_classifier Undocumented
Method visit_comment Undocumented
Method visit_compact_paragraph Undocumented
Method visit_danger Undocumented
Method visit_definition 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_doctest_block Undocumented
Method visit_download_reference Undocumented
Method visit_error Undocumented
Method visit_field Undocumented
Method visit_field_list Undocumented
Method visit_figure Undocumented
Method visit_glossary Undocumented
Method visit_hint Undocumented
Method visit_hlist Undocumented
Method visit_hlistcol Undocumented
Method visit_image Undocumented
Method visit_important Undocumented
Method visit_index Undocumented
Method visit_literal Undocumented
Method visit_literal_block 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_note Undocumented
Method visit_number_reference Undocumented
Method visit_production Undocumented
Method visit_productionlist Undocumented
Method visit_reference Undocumented
Method visit_row Undocumented
Method visit_seealso Undocumented
Method visit_start_of_file Undocumented
Method visit_table Undocumented
Method visit_tabular_col_spec Undocumented
Method visit_term Undocumented
Method visit_Text Undocumented
Method visit_tip Undocumented
Method visit_title Undocumented
Method visit_toctree Undocumented
Method visit_versionmodified Undocumented
Method visit_warning Undocumented
Class Variable builder Undocumented
Class Variable supported_inline_tags Undocumented
Instance Variable docnames Undocumented
Instance Variable first_param Undocumented
Instance Variable highlighter Undocumented
Instance Variable in_mailto Undocumented
Instance Variable manpages_url Undocumented
Instance Variable optional_param_level Undocumented
Instance Variable param_separator Undocumented
Instance Variable protect_literal_text Undocumented
Instance Variable required_params_left Undocumented
Instance Variable secnumber_suffix Undocumented
Instance Variable _fieldlist_row_indices Undocumented
Instance Variable _table_row_indices 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 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 add_fignumber(self, node): (source)

Undocumented

Parameters
node:ElementUndocumented
def add_permalink_ref(self, node, title): (source)

Undocumented

Parameters
node:ElementUndocumented
title:strUndocumented
def add_secnumber(self, node): (source)

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
def depart_admonition(self, node=None): (source)

Undocumented

Parameters
node:Element|NoneUndocumented
def depart_attention(self, node): (source)

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
def depart_definition(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_error(self, node): (source)

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
def depart_hint(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_image(self, node): (source)

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
def depart_literal(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, math_env=''): (source)

Undocumented

Parameters
node:ElementUndocumented
math_env:strUndocumented
def depart_math_block(self, node, math_env=''): (source)

Undocumented

Parameters
node:ElementUndocumented
math_env:strUndocumented
def depart_note(self, node): (source)

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
def depart_productionlist(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_table(self, node): (source)

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
def depart_tip(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 depart_warning(self, node): (source)

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
Returns
tuple[int, ...]|NoneUndocumented
def visit_abbreviation(self, node): (source)

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
def visit_admonition(self, node, name=''): (source)

Undocumented

Parameters
node:ElementUndocumented
name:strUndocumented
def visit_attention(self, node): (source)

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
def visit_classifier(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_danger(self, node): (source)

Undocumented

Parameters
node:ElementUndocumented
def visit_definition(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_doctest_block(self, node): (source)

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
def visit_hint(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_important(self, node): (source)

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
def visit_literal_block(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, math_env=''): (source)

Undocumented

Parameters
node:ElementUndocumented
math_env:strUndocumented
def visit_math_block(self, node, math_env=''): (source)

Undocumented

Parameters
node:ElementUndocumented
math_env:strUndocumented
def visit_note(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_reference(self, node): (source)

Undocumented

Parameters
node:ElementUndocumented
def visit_row(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_table(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_Text(self, node): (source)

Undocumented

Parameters
node:TextUndocumented
def visit_tip(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
def visit_warning(self, node): (source)

Undocumented

Parameters
node:ElementUndocumented
builder: StandaloneHTMLBuilder = (source)
overrides sphinx.util.docutils.SphinxTranslator.builder

Undocumented

supported_inline_tags: set[str] = (source)

Undocumented

docnames = (source)

Undocumented

first_param: int = (source)

Undocumented

highlighter = (source)

Undocumented

in_mailto: bool = (source)

Undocumented

manpages_url = (source)

Undocumented

optional_param_level: int = (source)

Undocumented

param_separator = (source)

Undocumented

protect_literal_text: int = (source)

Undocumented

required_params_left = (source)

Undocumented

secnumber_suffix = (source)

Undocumented

_fieldlist_row_indices: list[int] = (source)

Undocumented

_table_row_indices: list[int] = (source)

Undocumented