pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator

class documentation

class _SplitFieldsTranslator(nodes.NodeVisitor): (source)

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
Instance Variable _processtypes Undocumented
def __init__(self, document, errors, processtypes=False): (source)

Undocumented

Parameters
document:nodes.documentUndocumented
errors:List[ParseError]Undocumented
processtypes:boolUndocumented
def handle_consolidated_bullet_list(self, items, tagname): (source)

Undocumented

Parameters
items:Iterable[nodes.Node]Undocumented
tagname:strUndocumented
def handle_consolidated_definition_list(self, items, tagname): (source)

Undocumented

Parameters
items:Iterable[nodes.Node]Undocumented
tagname:strUndocumented
def handle_consolidated_field(self, body, tagname): (source)

Attempt to handle a consolidated section.

Parameters
body:Sequence[nodes.Node]Undocumented
tagname:strUndocumented
def unknown_visit(self, node): (source)

Ignore all unknown nodes

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

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:nodes.NodeUndocumented
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, arg, fbody, lineno): (source)

Undocumented

Parameters
tagname:strUndocumented
arg:Optional[str]Undocumented
fbody:Iterable[nodes.Node]Undocumented
lineno:intUndocumented
_errors = (source)

Undocumented

_newfields: Set[str] = (source)

Undocumented

_processtypes = (source)

Undocumented