pydoctor.node2stan.HTMLTranslator

class documentation

class HTMLTranslator(html4css1.HTMLTranslator): (source)

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 This modified version of starttag makes a few changes to HTML tags, to prevent them from conflicting with epydoc. In particular:
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 _compact Undocumented
Instance Variable _linker Undocumented
def __init__(self, document, docstring_linker, compact=False): (source)

Undocumented

Parameters
document:nodes.documentUndocumented
docstring_linker:DocstringLinkerUndocumented
compact:boolUndocumented
def depart_attention(self, node): (source)

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:nodes.NodeUndocumented
Returns
boolUndocumented
def starttag(self, node, tagname, suffix='\n', **attributes): (source)

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): (source)

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

settings: ClassVar[Optional[optparse.Values]] = (source)

Undocumented

def _handle_reference(self, node, link_func): (source)

Undocumented

Parameters
node:nodes.NodeUndocumented
link_func:Callable[[str, Flattenable], Flattenable]Undocumented
def _visit_admonition(self, node, name): (source)

Undocumented

Parameters
node:nodes.NodeUndocumented
name:strUndocumented
_compact = (source)

Undocumented

_linker = (source)

Undocumented