sphinx.writers.html.HTMLTranslator

class documentation

class HTMLTranslator(SphinxTranslator, BaseTranslator):

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​_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 generate​_targets​_for​_listing Generate hyperlink targets for listings.
Method get​_secnumber Undocumented
Method should​_be​_compact​_paragraph Determine if the <p> tags around paragraph can be omitted.
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​_entry Undocumented
Method visit​_enumerated​_list Undocumented
Method visit​_error Undocumented
Method visit​_field Undocumented
Method visit​_field​_list Undocumented
Method visit​_field​_name 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​_option​_group 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
Instance Variable ​_fieldlist​_row​_indices Undocumented
Instance Variable ​_table​_row​_indices 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
Property ​_fieldlist​_row​_index Undocumented
Property ​_table​_row​_index Undocumented
Property permalink​_text 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):
overrides sphinx.util.docutils.SphinxTranslator.__init__

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
math​_env:strUndocumented
def depart_math_block(self, node, math_env=''):

Undocumented

Parameters
node:ElementUndocumented
math​_env:strUndocumented
def depart_note(self, node):

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Generate hyperlink targets for listings.

Original visit_bullet_list(), visit_definition_list() and visit_enumerated_list() generates hyperlink targets inside listing tags (<ul>, <ol> and <dl>) if multiple IDs are assigned to listings. That is invalid DOM structure. (This is a bug of docutils <= 0.12)

This exports hyperlink targets before listings to make valid DOM structure.

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

Undocumented

Parameters
node:ElementUndocumented
Returns
Tuple[int, ...]Undocumented
def should_be_compact_paragraph(self, node):
Determine if the <p> tags around paragraph can be omitted.
Parameters
node:NodeUndocumented
Returns
boolUndocumented
def visit_abbreviation(self, node):

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
math​_env:strUndocumented
def visit_math_block(self, node, math_env=''):

Undocumented

Parameters
node:ElementUndocumented
math​_env:strUndocumented
def visit_note(self, node):

Undocumented

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

Undocumented

Parameters
node:ElementUndocumented
def visit_option_group(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_reference(self, node):

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

_fieldlist_row_indices: list[int] =

Undocumented

_table_row_indices: list[int] =

Undocumented

docnames =

Undocumented

first_param: int =

Undocumented

highlighter =

Undocumented

in_mailto: bool =

Undocumented

manpages_url =

Undocumented

optional_param_level: int =

Undocumented

param_separator =

Undocumented

protect_literal_text: int =

Undocumented

required_params_left =

Undocumented

secnumber_suffix =

Undocumented

@property
_fieldlist_row_index =

Undocumented

@property
_table_row_index =

Undocumented

@property
permalink_text: str =

Undocumented