Package epydoc :: Package markup :: Module restructuredtext :: Class _EpydocHTMLTranslator
[hide private]
[frames] | no frames]

ClassType _EpydocHTMLTranslator

source code


Instance Methods [hide private]
 
__init__(self, document, docstring_linker, directory, docindex, context) source code
call graph 
 
visit_title_reference(self, node) source code
call graph 
 
should_be_compact_paragraph(self, node)
Determine if the <p> tags around paragraph node can be omitted.
source code
call graph 
 
visit_document(self, node) source code
call graph 
 
depart_document(self, node) source code
call graph 
 
starttag(self, node, tagname, suffix='\n', **attributes)
This modified version of starttag makes a few changes to HTML tags, to prevent them from conflicting with epydoc.
source code
call graph 
 
visit_dotgraph(self, node) source code
call graph 
 
visit_doctest_block(self, node) source code
 
visit_emphasis(self, node) source code
call graph 

Inherited from docutils.writers.html4css1.HTMLTranslator: add_meta, astext, attval, check_simple_list, cloak_email, cloak_mailto, depart_Text, depart_abbreviation, depart_acronym, depart_address, depart_admonition, depart_attribution, depart_author, depart_authors, depart_block_quote, depart_bullet_list, depart_caption, depart_citation, depart_citation_reference, depart_classifier, depart_colspec, depart_compound, depart_contact, depart_container, depart_copyright, depart_date, depart_decoration, depart_definition, depart_definition_list, depart_definition_list_item, depart_description, depart_docinfo, depart_docinfo_item, depart_doctest_block, depart_emphasis, depart_entry, depart_enumerated_list, depart_field, depart_field_body, depart_field_list, depart_field_name, depart_figure, depart_footer, depart_footnote, depart_footnote_reference, depart_generated, depart_header, depart_image, depart_inline, depart_label, depart_legend, depart_line, depart_line_block, depart_list_item, depart_literal_block, depart_meta, depart_option, depart_option_argument, depart_option_group, depart_option_list, depart_option_list_item, depart_option_string, depart_organization, depart_paragraph, depart_problematic, depart_reference, depart_revision, depart_row, depart_rubric, depart_section, depart_sidebar, depart_status, depart_strong, depart_subscript, depart_subtitle, depart_superscript, depart_system_message, depart_table, depart_target, depart_tbody, depart_term, depart_tgroup, depart_thead, depart_title, depart_title_reference, depart_topic, depart_transition, depart_version, emptytag, encode, footnote_backrefs, is_compactable, set_class_on_child, set_first_last, unimplemented_visit, visit_Text, visit_abbreviation, visit_acronym, visit_address, visit_admonition, visit_attribution, visit_author, visit_authors, visit_block_quote, visit_bullet_list, visit_caption, visit_citation, visit_citation_reference, visit_classifier, visit_colspec, visit_comment, visit_compound, visit_contact, visit_container, visit_copyright, visit_date, visit_decoration, visit_definition, visit_definition_list, visit_definition_list_item, visit_description, visit_docinfo, visit_docinfo_item, visit_entry, visit_enumerated_list, visit_field, visit_field_body, visit_field_list, visit_field_name, visit_figure, visit_footer, visit_footnote, visit_footnote_reference, visit_generated, visit_header, visit_image, visit_inline, visit_label, visit_legend, visit_line, visit_line_block, visit_list_item, visit_literal, visit_literal_block, visit_meta, visit_option, visit_option_argument, visit_option_group, visit_option_list, visit_option_list_item, visit_option_string, visit_organization, visit_paragraph, visit_problematic, visit_raw, visit_reference, visit_revision, visit_row, visit_rubric, visit_section, visit_sidebar, visit_status, visit_strong, visit_subscript, visit_substitution_definition, visit_substitution_reference, visit_subtitle, visit_superscript, visit_system_message, visit_table, visit_target, visit_tbody, visit_term, visit_tgroup, visit_thead, visit_title, visit_topic, visit_transition, visit_version, write_colspecs

Inherited from docutils.nodes.NodeVisitor: dispatch_departure, dispatch_visit, unknown_departure, unknown_visit

Class Variables [hide private]
  settings = None

Inherited from docutils.writers.html4css1.HTMLTranslator: attribution_formats, content_type, doctype, embedded_stylesheet, generator, head_prefix_template, stylesheet_link, words_and_spaces, xml_declaration

Inherited from docutils.nodes.NodeVisitor: optional

Method Details [hide private]

__init__(self, document, docstring_linker, directory, docindex, context)
(Constructor)

source code 
call graph 
Overrides: docutils.nodes.NodeVisitor.__init__

visit_title_reference(self, node)

source code 
call graph 
Overrides: docutils.writers.html4css1.HTMLTranslator.visit_title_reference

should_be_compact_paragraph(self, node)

source code 
call graph 
Determine if the <p> tags around paragraph node can be omitted.
Overrides: docutils.writers.html4css1.HTMLTranslator.should_be_compact_paragraph
(inherited documentation)

visit_document(self, node)

source code 
call graph 
Overrides: docutils.writers.html4css1.HTMLTranslator.visit_document

depart_document(self, node)

source code 
call graph 
Overrides: docutils.writers.html4css1.HTMLTranslator.depart_document

starttag(self, node, tagname, suffix='\n', **attributes)

source code 
call graph 

This modified version of starttag makes a few changes to HTML tags, to prevent them from conflicting with epydoc. In particular:

  • existing class attributes are prefixed with 'rst-'
  • existing names are prefixed with 'rst-'
  • hrefs starting with '#' are prefixed with 'rst-'
  • hrefs not starting with '#' are given target='_top'
  • all headings (<hn>) are given the css class 'heading'
Overrides: docutils.writers.html4css1.HTMLTranslator.starttag

visit_doctest_block(self, node)

source code 
Overrides: docutils.writers.html4css1.HTMLTranslator.visit_doctest_block

visit_emphasis(self, node)

source code 
call graph 
Overrides: docutils.writers.html4css1.HTMLTranslator.visit_emphasis