pydoctor.node2stan.HTMLTranslator

class documentation

class HTMLTranslator(html4css1.HTMLTranslator): (source)

Constructor: HTMLTranslator(document, docstring_linker)

Pydoctor's HTML translator.

Method	`__init__`	Undocumented
Method	`depart_admonition`	Undocumented
Method	`depart_attention`	Undocumented
Method	`depart_caution`	Undocumented
Method	`depart_code`	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_code`	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	`_document_is_code`	Undocumented
Instance Variable	`_link_xref`	Undocumented
Instance Variable	`_linker`	Undocumented

def __init__(self, document: nodes.document, docstring_linker: DocstringLinker): (source) ¶

Undocumented

def depart_admonition(self, node: nodes.Admonition): (source) ¶

Undocumented

def depart_attention(self, node: nodes.attention): (source) ¶

Undocumented

def depart_caution(self, node: nodes.caution): (source) ¶

Undocumented

def depart_code(self, node: code): (source) ¶

Undocumented

def depart_danger(self, node: nodes.danger): (source) ¶

Undocumented

def depart_document(self, node: nodes.document): (source) ¶

Undocumented

def depart_error(self, node: nodes.error): (source) ¶

Undocumented

def depart_hint(self, node: nodes.hint): (source) ¶

Undocumented

def depart_important(self, node: nodes.important): (source) ¶

Undocumented

def depart_note(self, node: nodes.note): (source) ¶

Undocumented

def depart_seealso(self, node: nodes.Admonition): (source) ¶

Undocumented

def depart_tip(self, node: nodes.tip): (source) ¶

Undocumented

def depart_versionmodified(self, node: nodes.Element): (source) ¶

Undocumented

def depart_warning(self, node: nodes.warning): (source) ¶

Undocumented

def depart_wbr(self, node: wbr): (source) ¶

Undocumented

def should_be_compact_paragraph(self, node: nodes.Element) -> bool: (source) ¶

Undocumented

def starttag(self, node: nodes.Element, tagname: str, suffix: str = '\n', *args: Any, **attributes: Any) -> str: (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'

def visit_attention(self, node: nodes.attention): (source) ¶

Undocumented

def visit_caution(self, node: nodes.caution): (source) ¶

Undocumented

def visit_code(self, node: code): (source) ¶

Undocumented

def visit_danger(self, node: nodes.danger): (source) ¶

Undocumented

def visit_doctest_block(self, node: nodes.doctest_block): (source) ¶

Undocumented

def visit_document(self, node: nodes.document): (source) ¶

Undocumented

def visit_error(self, node: nodes.error): (source) ¶

Undocumented

def visit_hint(self, node: nodes.hint): (source) ¶

Undocumented

def visit_important(self, node: nodes.important): (source) ¶

Undocumented

def visit_note(self, node: nodes.note): (source) ¶

Undocumented

def visit_obj_reference(self, node: obj_reference): (source) ¶

Undocumented

def visit_seealso(self, node: nodes.Element): (source) ¶

Undocumented

def visit_tip(self, node: nodes.tip): (source) ¶

Undocumented

def visit_title_reference(self, node: nodes.title_reference): (source) ¶

Undocumented

def visit_versionmodified(self, node: nodes.Element): (source) ¶

Undocumented

def visit_warning(self, node: nodes.warning): (source) ¶

Undocumented

def visit_wbr(self, node: wbr): (source) ¶

Undocumented

body: list[str] = (source) ¶

Undocumented

settings: optparse.Values | None = (source) ¶

Undocumented

def _handle_reference(self, node: nodes.title_reference, link_func: Callable[[str, Flattenable], Flattenable]): (source) ¶

Undocumented

def _visit_admonition(self, node: nodes.Element, name: str): (source) ¶

Undocumented

_document_is_code = (source) ¶

Undocumented

_link_xref = (source) ¶

Undocumented

_linker = (source) ¶

Undocumented