pydoctor.epydoc.markup.restructuredtext._SplitFieldsTranslator

class documentation

class _SplitFieldsTranslator(nodes.NodeVisitor):

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 No summary
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):

Undocumented

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

Undocumented

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

Undocumented

Parameters
items:Iterable[nodes.Node]Undocumented
tagname:strUndocumented
def handle_consolidated_field(self, body, tagname):
Attempt to handle a consolidated section.
Parameters
body:Sequence[nodes.Node]Undocumented
tagname:strUndocumented
def unknown_visit(self, node):
Ignore all unknown nodes
Parameters
node:nodes.NodeUndocumented
def visit_document(self, node):

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:nodes.NodeUndocumented
ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD: bool =
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 =
The fields of the most recently walked document.
def _add_field(self, tagname, arg, fbody, lineno):

Undocumented

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

Undocumented

_newfields: Set[str] =

Undocumented

_processtypes =

Undocumented