epydoc.markup.restructuredtext._SplitFieldsTranslator

Package epydoc :: Package markup :: Module restructuredtext :: Class _SplitFieldsTranslator

Class _SplitFieldsTranslator
source code

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

Instance Methods	[hide private]

__init__(self, document, errors)

visit_document(self, node)

visit_field(self, node)

_add_field(self, tagname, arg, fbody)

visit_field_list(self, node)

handle_consolidated_field(self, body, tagname)
Attempt to handle a consolidated section.

handle_consolidated_bullet_list(self, items, tagname)

handle_consolidated_definition_list(self, items, tagname)

unknown_visit(self, node)
Ignore all unknown nodes

Inherited from docutils.nodes.NodeVisitor: dispatch_departure, dispatch_visit, unknown_departure

Class Variables	[hide private]

Inherited from docutils.nodes.NodeVisitor: optional

Instance Variables	[hide private]

fields

The fields of the most recently walked document.

Method Details	[hide private]

init(self, document, errors)
(Constructor)

source code
call graph

Overrides: docutils.nodes.NodeVisitor.__init__

visit_document(self, node)

source code
call graph

visit_field(self, node)

source code
call graph

_add_field(self, tagname, arg, fbody)

source code
call graph

visit_field_list(self, node)

source code
call graph

handle_consolidated_field(self, body, tagname)

source code

Attempt to handle a consolidated section.

handle_consolidated_bullet_list(self, items, tagname)

source code

handle_consolidated_definition_list(self, items, tagname)

source code

unknown_visit(self, node)

source code

Ignore all unknown nodes

Overrides: docutils.nodes.NodeVisitor.unknown_visit

Instance Variable Details	[hide private]

fields

The fields of the most recently walked document.

Type:: list of Field

Class _SplitFieldsTranslator source code

__init__(self, document, errors) (Constructor)

visit_document(self, node)

visit_field(self, node)

_add_field(self, tagname, arg, fbody)

visit_field_list(self, node)

handle_consolidated_field(self, body, tagname)

handle_consolidated_bullet_list(self, items, tagname)

handle_consolidated_definition_list(self, items, tagname)

unknown_visit(self, node)

fields

Class _SplitFieldsTranslator
source code

init(self, document, errors)
(Constructor)