Twisted
Home FAQ Docs Download Timeline Roadmap View Tickets Search

pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator

class documentation

class _SplitFieldsTranslator(nodes.NodeVisitor): (source)

Constructor: _SplitFieldsTranslator(document, errors)

View In Hierarchy

A docutils translator that removes all fields from a document, and collects them into the instance variable fields

Method __init__ Undocumented
Method handle_consolidated_bullet_list Undocumented
Method handle_consolidated_definition_list Undocumented
Method handle_consolidated_field Attempt to handle a consolidated section.
Method unknown_visit Ignore all unknown nodes
Method visit_document Undocumented
Method visit_field Undocumented
Method visit_field_list Undocumented
Constant ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD If true, then consolidated fields are not required to mark arguments with `backticks`. (This is currently only implemented for consolidated fields expressed as definition lists; consolidated fields expressed as unordered lists still require backticks for now.
Instance Variable fields The fields of the most recently walked document.
Method _add_field Undocumented
Instance Variable _errors Undocumented
Instance Variable _newfields Undocumented
def __init__(self, document: nodes.document, errors: list[ParseError]): (source)

Undocumented

def handle_consolidated_bullet_list(self, items: nodes.bullet_list, tagname: str): (source)

Undocumented

def handle_consolidated_definition_list(self, items: nodes.definition_list, tagname: str): (source)

Undocumented

def handle_consolidated_field(self, body: nodes.Element, tagname: str): (source)

Attempt to handle a consolidated section.

def unknown_visit(self, node: nodes.Node): (source)

Ignore all unknown nodes

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

Undocumented

def visit_field(self, node: nodes.field): (source)

Undocumented

def visit_field_list(self, node: nodes.field_list): (source)

Undocumented

ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD: bool = (source)

If true, then consolidated fields are not required to mark arguments with `backticks`. (This is currently only implemented for consolidated fields expressed as definition lists; consolidated fields expressed as unordered lists still require backticks for now.

Value
True
fields: list of Field = (source)

The fields of the most recently walked document.

def _add_field(self, tagname: str, arg: str | None, fbody: Iterable[nodes.Node], lineno: int | None): (source)

Undocumented

_errors = (source)

Undocumented

_newfields: set[str] = (source)

Undocumented