pydoctor.node2stan.HTMLTranslator

class documentation

class HTMLTranslator(html4css1.HTMLTranslator):

View In Hierarchy

Pydoctor's HTML translator.
Method __init__ Undocumented
Method depart​_attention Undocumented
Method depart​_caution Undocumented
Method depart​_danger Undocumented
Method depart​_document Undocumented
Method depart​_error Undocumented
Method depart​_hint Undocumented
Method depart​_important Undocumented
Method depart​_note Undocumented
Method depart​_seealso Undocumented
Method depart​_tip Undocumented
Method depart​_versionmodified Undocumented
Method depart​_warning Undocumented
Method depart​_wbr Undocumented
Method should​_be​_compact​_paragraph Undocumented
Method starttag No summary
Method visit​_attention Undocumented
Method visit​_caution Undocumented
Method visit​_danger Undocumented
Method visit​_doctest​_block Undocumented
Method visit​_document Undocumented
Method visit​_error Undocumented
Method visit​_hint Undocumented
Method visit​_important Undocumented
Method visit​_note Undocumented
Method visit​_obj​_reference Undocumented
Method visit​_seealso Undocumented
Method visit​_tip Undocumented
Method visit​_title​_reference Undocumented
Method visit​_versionmodified Undocumented
Method visit​_warning Undocumented
Method visit​_wbr Undocumented
Class Variable body Undocumented
Class Variable settings Undocumented
Method ​_handle​_reference Undocumented
Method ​_visit​_admonition Undocumented
Instance Variable ​_linker Undocumented
def __init__(self, document, docstring_linker):

Undocumented

Parameters
document:nodes.documentUndocumented
docstring​_linker:DocstringLinkerUndocumented
def depart_attention(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def depart_caution(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def depart_danger(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def depart_document(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def depart_error(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def depart_hint(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def depart_important(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def depart_note(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def depart_seealso(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def depart_tip(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def depart_versionmodified(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def depart_warning(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def depart_wbr(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def should_be_compact_paragraph(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
Returns
boolUndocumented
def 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. 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'
Parameters
node:nodes.NodeUndocumented
tagname:strUndocumented
suffix:strUndocumented
**attributes:AnyUndocumented
Returns
strUndocumented
def visit_attention(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_caution(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_danger(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_doctest_block(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_document(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_error(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_hint(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_important(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_note(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_obj_reference(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_seealso(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_tip(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_title_reference(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_versionmodified(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_warning(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
def visit_wbr(self, node):

Undocumented

Parameters
node:nodes.NodeUndocumented
body: List[str] =

Undocumented

settings: ClassVar[Optional[optparse.Values]] =

Undocumented

def _handle_reference(self, node, link_func):

Undocumented

Parameters
node:nodes.NodeUndocumented
link​_func:Callable[[str, Flattenable], Flattenable]Undocumented
def _visit_admonition(self, node, name):

Undocumented

Parameters
node:nodes.NodeUndocumented
name:strUndocumented
_linker =

Undocumented