docutils.writers._html_base.HTMLTranslator

class documentation

class HTMLTranslator(nodes.NodeVisitor): (source)

Known subclasses: docutils.writers.html4css1.HTMLTranslator, docutils.writers.html5_polyglot.HTMLTranslator

View In Hierarchy

Generic Docutils to HTML translator. See the `html4css1` and `html5_polyglot` writers for full featured HTML writers. .. IMPORTANT:: The `visit_*` and `depart_*` methods use a heterogeneous stack, `self.context`. When subclassing, make sure to be consistent in its use! Examples for robust coding: a) Override both `visit_*` and `depart_*` methods, don't call the parent functions. b) Extend both and unconditionally call the parent functions:: def visit_example(self, node): if foo: self.body.append('<div class="foo">') html4css1.HTMLTranslator.visit_example(self, node) def depart_example(self, node): html4css1.HTMLTranslator.depart_example(self, node) if foo: self.body.append('</div>') c) Extend both, calling the parent functions under the same conditions:: def visit_example(self, node): if foo: self.body.append('<div class="foo"> ') else: # call the parent method _html_base.HTMLTranslator.visit_example(self, node) def depart_example(self, node): if foo: self.body.append('</div> ') else: # call the parent method _html_base.HTMLTranslator.depart_example(self, node) d) Extend one method (call the parent), but don't otherwise use the `self.context` stack:: def depart_example(self, node): _html_base.HTMLTranslator.depart_example(self, node) if foo: # implementation-specific code # that does not use `self.context` self.body.append('</div> ') This way, changes in stack use will not bite you.

Method __init__ Undocumented
Method add_meta Undocumented
Method astext Undocumented
Method attval Cleanse, HTML encode, and return attribute value text.
Method check_simple_list Check for a simple list that can be rendered compactly.
Method cloak_email Try to hide the link text of a email link from harversters.
Method cloak_mailto Try to hide a mailto: URL from harvesters.
Method depart_abbreviation Undocumented
Method depart_acronym Undocumented
Method depart_address Undocumented
Method depart_admonition Undocumented
Method depart_attribution Undocumented
Method depart_author Undocumented
Method depart_authors Undocumented
Method depart_block_quote Undocumented
Method depart_bullet_list Undocumented
Method depart_caption Undocumented
Method depart_citation Undocumented
Method depart_citation_reference Undocumented
Method depart_classifier Undocumented
Method depart_colspec Undocumented
Method depart_compound Undocumented
Method depart_contact Undocumented
Method depart_container Undocumented
Method depart_copyright Undocumented
Method depart_date Undocumented
Method depart_decoration Undocumented
Method depart_definition Undocumented
Method depart_definition_list Undocumented
Method depart_definition_list_item Undocumented
Method depart_description Undocumented
Method depart_docinfo Undocumented
Method depart_docinfo_item Undocumented
Method depart_doctest_block Undocumented
Method depart_document Undocumented
Method depart_emphasis Undocumented
Method depart_entry Undocumented
Method depart_enumerated_list Undocumented
Method depart_field Undocumented
Method depart_field_body Undocumented
Method depart_field_list Undocumented
Method depart_field_name Undocumented
Method depart_figure Undocumented
Method depart_footer Undocumented
Method depart_footnote Undocumented
Method depart_footnote_reference Undocumented
Method depart_generated Undocumented
Method depart_header Undocumented
Method depart_image Undocumented
Method depart_inline Undocumented
Method depart_label Undocumented
Method depart_legend Undocumented
Method depart_line Undocumented
Method depart_line_block Undocumented
Method depart_list_item Undocumented
Method depart_literal Undocumented
Method depart_literal_block Undocumented
Method depart_math Undocumented
Method depart_math_block Undocumented
Method depart_meta Undocumented
Method depart_option Undocumented
Method depart_option_argument Undocumented
Method depart_option_group Undocumented
Method depart_option_list Undocumented
Method depart_option_list_item Undocumented
Method depart_option_string Undocumented
Method depart_organization Undocumented
Method depart_paragraph Undocumented
Method depart_problematic Undocumented
Method depart_reference Undocumented
Method depart_revision Undocumented
Method depart_row Undocumented
Method depart_rubric Undocumented
Method depart_section Undocumented
Method depart_sidebar Undocumented
Method depart_status Undocumented
Method depart_strong Undocumented
Method depart_subscript Undocumented
Method depart_subtitle Undocumented
Method depart_superscript Undocumented
Method depart_system_message Undocumented
Method depart_table Undocumented
Method depart_target Undocumented
Method depart_tbody Undocumented
Method depart_term Undocumented
Method depart_Text Undocumented
Method depart_tgroup Undocumented
Method depart_thead Undocumented
Method depart_title Undocumented
Method depart_title_reference Undocumented
Method depart_topic Undocumented
Method depart_transition Undocumented
Method depart_version Undocumented
Method emptytag Construct and return an XML-compatible empty tag.
Method encode Encode special characters in `text` & return.
Method is_compactable Undocumented
Method section_title_tags Undocumented
Method set_class_on_child Set class `class_` on the visible child no. index of `node`. Do nothing if node has fewer children than `index`.
Method starttag Construct and return a start tag given a node (id & class attributes are extracted), tag name, and optional attributes.
Method stylesheet_call Return code to reference or embed stylesheet file `path`
Method unimplemented_visit Undocumented
Method visit_abbreviation Undocumented
Method visit_acronym Undocumented
Method visit_address Undocumented
Method visit_admonition Undocumented
Method visit_attribution Undocumented
Method visit_author Undocumented
Method visit_authors Undocumented
Method visit_block_quote Undocumented
Method visit_bullet_list Undocumented
Method visit_caption Undocumented
Method visit_citation Undocumented
Method visit_citation_reference Undocumented
Method visit_classifier Undocumented
Method visit_colspec Undocumented
Method visit_comment Escape double-dashes in comment text.
Method visit_compound Undocumented
Method visit_contact Undocumented
Method visit_container Undocumented
Method visit_copyright Undocumented
Method visit_date Undocumented
Method visit_decoration Undocumented
Method visit_definition Undocumented
Method visit_definition_list Undocumented
Method visit_definition_list_item Undocumented
Method visit_description Undocumented
Method visit_docinfo Undocumented
Method visit_docinfo_item Undocumented
Method visit_doctest_block Undocumented
Method visit_document Undocumented
Method visit_emphasis Undocumented
Method visit_entry Undocumented
Method visit_enumerated_list Undocumented
Method visit_field Undocumented
Method visit_field_body Undocumented
Method visit_field_list Undocumented
Method visit_field_name Undocumented
Method visit_figure Undocumented
Method visit_footer Undocumented
Method visit_footnote Undocumented
Method visit_footnote_reference Undocumented
Method visit_generated Undocumented
Method visit_header Undocumented
Method visit_image Undocumented
Method visit_inline Undocumented
Method visit_label Undocumented
Method visit_legend Undocumented
Method visit_line Undocumented
Method visit_line_block Undocumented
Method visit_list_item Undocumented
Method visit_literal Undocumented
Method visit_literal_block Undocumented
Method visit_math Undocumented
Method visit_math_block Undocumented
Method visit_meta Undocumented
Method visit_option Undocumented
Method visit_option_argument Undocumented
Method visit_option_group Undocumented
Method visit_option_list Undocumented
Method visit_option_list_item Undocumented
Method visit_option_string Undocumented
Method visit_organization Undocumented
Method visit_paragraph Undocumented
Method visit_problematic Undocumented
Method visit_raw Undocumented
Method visit_reference Undocumented
Method visit_revision Undocumented
Method visit_row Undocumented
Method visit_rubric Undocumented
Method visit_section Undocumented
Method visit_sidebar Undocumented
Method visit_status Undocumented
Method visit_strong Undocumented
Method visit_subscript Undocumented
Method visit_substitution_definition Internal only.
Method visit_substitution_reference Undocumented
Method visit_subtitle Undocumented
Method visit_superscript Undocumented
Method visit_system_message Undocumented
Method visit_table Undocumented
Method visit_target Undocumented
Method visit_tbody Undocumented
Method visit_term Undocumented
Method visit_Text Undocumented
Method visit_tgroup Undocumented
Method visit_thead Undocumented
Method visit_title Undocumented
Method visit_title_reference Undocumented
Method visit_topic Undocumented
Method visit_transition Undocumented
Method visit_version Undocumented
Class Variable attribution_formats Undocumented
Class Variable content_type Undocumented
Class Variable doctype Undocumented
Class Variable embedded_stylesheet Undocumented
Class Variable generator Undocumented
Class Variable head_prefix_template Undocumented
Class Variable in_word_wrap_point Undocumented
Class Variable lang_attribute Undocumented
Class Variable math_tags Undocumented
Class Variable mathjax_script Undocumented
Class Variable special_characters Character references for characters with a special meaning in HTML.
Class Variable stylesheet_link Undocumented
Class Variable words_and_spaces Undocumented
Class Variable xml_declaration Undocumented
Instance Variable author_in_authors Undocumented
Instance Variable body Undocumented
Instance Variable body_pre_docinfo Undocumented
Instance Variable body_prefix Undocumented
Instance Variable body_suffix Undocumented
Instance Variable colspecs Undocumented
Instance Variable compact_field_list Undocumented
Instance Variable compact_p Undocumented
Instance Variable compact_simple Undocumented
Instance Variable context Heterogeneous stack.
Instance Variable docinfo Undocumented
Instance Variable footer Undocumented
Instance Variable fragment Undocumented
Instance Variable head Undocumented
Instance Variable head_prefix Undocumented
Instance Variable header Undocumented
Instance Variable html_body Undocumented
Instance Variable html_head Undocumented
Instance Variable html_prolog Undocumented
Instance Variable html_subtitle Undocumented
Instance Variable html_title Undocumented
Instance Variable image_loading Undocumented
Instance Variable in_docinfo Undocumented
Instance Variable in_document_title Undocumented
Instance Variable in_mailto Undocumented
Instance Variable in_sidebar Undocumented
Instance Variable initial_header_level Undocumented
Instance Variable language Undocumented
Instance Variable math_header Undocumented
Instance Variable math_output Undocumented
Instance Variable math_output_options Undocumented
Instance Variable mathjax_url URL of the MathJax javascript library.
Instance Variable meta Undocumented
Instance Variable section_level Undocumented
Instance Variable settings Undocumented
Instance Variable stylesheet Undocumented
Instance Variable subtitle Undocumented
Instance Variable title Undocumented

Inherited from NodeVisitor:

Method dispatch_departure Call self."``depart_`` + node class name" with `node` as parameter. If the ``depart_...`` method does not exist, call self.unknown_departure.
Method dispatch_visit Call self."``visit_`` + node class name" with `node` as parameter. If the ``visit_...`` method does not exist, call self.unknown_visit.
Method unknown_departure Called before exiting unknown `Node` types.
Method unknown_visit Called when entering unknown `Node` types.
Class Variable optional Tuple containing node class names (as strings).
Instance Variable document Undocumented
def __init__(self, document): (source)
overrides docutils.nodes.NodeVisitor.__init__
overridden in docutils.writers.s5_html.S5HTMLTranslator

Undocumented

def add_meta(self, tag): (source)

Undocumented

def astext(self): (source)

Undocumented

def attval(self, text, whitespace=re.compile('[\n\r\t\v\f]')): (source)

Cleanse, HTML encode, and return attribute value text.

def check_simple_list(self, node): (source)

Check for a simple list that can be rendered compactly.

def cloak_email(self, addr): (source)

Try to hide the link text of a email link from harversters.

def cloak_mailto(self, uri): (source)

Try to hide a mailto: URL from harvesters.

def depart_abbreviation(self, node): (source)

Undocumented

def depart_acronym(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_address(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_admonition(self, node=None): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_attribution(self, node): (source)

Undocumented

def depart_author(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_authors(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator, docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_block_quote(self, node): (source)

Undocumented

def depart_bullet_list(self, node): (source)

Undocumented

def depart_caption(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_citation(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_citation_reference(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_classifier(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_colspec(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_compound(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_contact(self, node): (source)

Undocumented

def depart_container(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_copyright(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_date(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_decoration(self, node): (source)

Undocumented

def depart_definition(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_definition_list(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_definition_list_item(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_description(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_docinfo(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_docinfo_item(self): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_doctest_block(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_document(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator, docutils.writers.s5_html.S5HTMLTranslator

Undocumented

def depart_emphasis(self, node): (source)

Undocumented

def depart_entry(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_enumerated_list(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_field(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_field_body(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_field_list(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_field_name(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_figure(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_footer(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator, docutils.writers.s5_html.S5HTMLTranslator

Undocumented

def depart_footnote(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_footnote_reference(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_generated(self, node): (source)

Undocumented

def depart_header(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator, docutils.writers.s5_html.S5HTMLTranslator

Undocumented

def depart_image(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator, docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_inline(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_label(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_legend(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_line(self, node): (source)

Undocumented

def depart_line_block(self, node): (source)

Undocumented

def depart_list_item(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_literal(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator, docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_literal_block(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_math(self, node): (source)

Undocumented

def depart_math_block(self, node): (source)

Undocumented

def depart_meta(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_option(self, node): (source)

Undocumented

def depart_option_argument(self, node): (source)

Undocumented

def depart_option_group(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_option_list(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_option_list_item(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_option_string(self, node): (source)

Undocumented

def depart_organization(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_paragraph(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_problematic(self, node): (source)

Undocumented

def depart_reference(self, node): (source)

Undocumented

def depart_revision(self, node): (source)

Undocumented

def depart_row(self, node): (source)

Undocumented

def depart_rubric(self, node): (source)

Undocumented

def depart_section(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_sidebar(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator, docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_status(self, node): (source)

Undocumented

def depart_strong(self, node): (source)

Undocumented

def depart_subscript(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_subtitle(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_superscript(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_system_message(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_table(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_target(self, node): (source)

Undocumented

def depart_tbody(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_term(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_Text(self, node): (source)

Undocumented

def depart_tgroup(self, node): (source)

Undocumented

def depart_thead(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def depart_title(self, node): (source)

Undocumented

def depart_title_reference(self, node): (source)

Undocumented

def depart_topic(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def depart_transition(self, node): (source)

Undocumented

def depart_version(self, node): (source)

Undocumented

def emptytag(self, node, tagname, suffix='\n', **attributes): (source)

Construct and return an XML-compatible empty tag.

def encode(self, text): (source)

Encode special characters in `text` & return.

def is_compactable(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def section_title_tags(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator, docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def set_class_on_child(self, node, class_, index=0): (source)

Set class `class_` on the visible child no. index of `node`. Do nothing if node has fewer children than `index`.

def starttag(self, node, tagname, suffix='\n', empty=False, **attributes): (source)

Construct and return a start tag given a node (id & class attributes are extracted), tag name, and optional attributes.

def stylesheet_call(self, path, adjust_path=None): (source)

Return code to reference or embed stylesheet file `path`

def unimplemented_visit(self, node): (source)

Undocumented

def visit_abbreviation(self, node): (source)

Undocumented

def visit_acronym(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_address(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_admonition(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_attribution(self, node): (source)

Undocumented

def visit_author(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_authors(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator, docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_block_quote(self, node): (source)

Undocumented

def visit_bullet_list(self, node): (source)

Undocumented

def visit_caption(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_citation(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_citation_reference(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_classifier(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_colspec(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_comment(self, node, sub=re.compile('-(?=-)').sub): (source)

Escape double-dashes in comment text.

def visit_compound(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_contact(self, node): (source)

Undocumented

def visit_container(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_copyright(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_date(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_decoration(self, node): (source)

Undocumented

def visit_definition(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_definition_list(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_definition_list_item(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_description(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_docinfo(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_docinfo_item(self, node, name, meta=True): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_doctest_block(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_document(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_emphasis(self, node): (source)

Undocumented

def visit_entry(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_enumerated_list(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_field(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_field_body(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_field_list(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_field_name(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_figure(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_footer(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_footnote(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_footnote_reference(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_generated(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_header(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_image(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator, docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_inline(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_label(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_legend(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_line(self, node): (source)

Undocumented

def visit_line_block(self, node): (source)

Undocumented

def visit_list_item(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_literal(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator, docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_literal_block(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_math(self, node, math_env=''): (source)

Undocumented

def visit_math_block(self, node): (source)

Undocumented

def visit_meta(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_option(self, node): (source)

Undocumented

def visit_option_argument(self, node): (source)

Undocumented

def visit_option_group(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_option_list(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_option_list_item(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_option_string(self, node): (source)

Undocumented

def visit_organization(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_paragraph(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_problematic(self, node): (source)

Undocumented

def visit_raw(self, node): (source)

Undocumented

def visit_reference(self, node): (source)

Undocumented

def visit_revision(self, node): (source)

Undocumented

def visit_row(self, node): (source)

Undocumented

def visit_rubric(self, node): (source)

Undocumented

def visit_section(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator, docutils.writers.s5_html.S5HTMLTranslator

Undocumented

def visit_sidebar(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator, docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_status(self, node): (source)

Undocumented

def visit_strong(self, node): (source)

Undocumented

def visit_subscript(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_substitution_definition(self, node): (source)

Internal only.

def visit_substitution_reference(self, node): (source)

Undocumented

def visit_subtitle(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_superscript(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_system_message(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_table(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_target(self, node): (source)

Undocumented

def visit_tbody(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_term(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_Text(self, node): (source)

Undocumented

def visit_tgroup(self, node): (source)

Undocumented

def visit_thead(self, node): (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

def visit_title(self, node): (source)
overridden in docutils.writers.s5_html.S5HTMLTranslator

Undocumented

def visit_title_reference(self, node): (source)

Undocumented

def visit_topic(self, node): (source)
overridden in docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

def visit_transition(self, node): (source)

Undocumented

def visit_version(self, node): (source)

Undocumented

attribution_formats: dict = (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

content_type: str = (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

doctype: str = (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

embedded_stylesheet: str = (source)

Undocumented

generator: str = (source)

Undocumented

head_prefix_template: str = (source)

Undocumented

in_word_wrap_point = (source)

Undocumented

lang_attribute: str = (source)

Undocumented

math_tags: dict = (source)

Undocumented

mathjax_script: str = (source)

Undocumented

special_characters = (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Character references for characters with a special meaning in HTML.

stylesheet_link: str = (source)

Undocumented

words_and_spaces = (source)

Undocumented

xml_declaration: str = (source)

Undocumented

author_in_authors: bool = (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

body: list = (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

body_pre_docinfo: list = (source)

Undocumented

body_prefix: list[str] = (source)

Undocumented

body_suffix: list[str] = (source)

Undocumented

colspecs: list = (source)

Undocumented

compact_field_list: bool = (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

compact_p = (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

compact_simple = (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

context: list = (source)

Heterogeneous stack. Used by visit_* and depart_* functions in conjunction with the tree traversal. Make sure that the pops correspond to the pushes.

docinfo = (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

footer: list = (source)

Undocumented

fragment: list = (source)

Undocumented

head = (source)

Undocumented

head_prefix: list = (source)

Undocumented

header: list = (source)

Undocumented

html_body: list = (source)

Undocumented

html_head = (source)

Undocumented

html_prolog: list = (source)

Undocumented

html_subtitle: list = (source)

Undocumented

html_title: list = (source)

Undocumented

image_loading: str = (source)

Undocumented

in_docinfo: bool = (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

in_document_title: int = (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

in_mailto: bool = (source)

Undocumented

in_sidebar: bool = (source)
overridden in docutils.writers.html4css1.HTMLTranslator, docutils.writers.html5_polyglot.HTMLTranslator

Undocumented

initial_header_level = (source)

Undocumented

language = (source)

Undocumented

math_header = (source)

Undocumented

math_output: str = (source)

Undocumented

math_output_options = (source)

Undocumented

mathjax_url = (source)

URL of the MathJax javascript library. The MathJax library ought to be installed on the same server as the rest of the deployed site files and specified in the `math-output` setting appended to "mathjax". See `Docutils Configuration`__. __ https://docutils.sourceforge.io/docs/user/config.html#math-output The fallback tries a local MathJax installation at ``/usr/share/javascript/mathjax/MathJax.js``.

meta = (source)

Undocumented

section_level: int = (source)

Undocumented

settings = (source)

Undocumented

stylesheet = (source)

Undocumented

subtitle = (source)
overridden in docutils.writers.html4css1.HTMLTranslator

Undocumented

title = (source)

Undocumented