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

[frames] | no frames]

ClassType _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)

source code
call graph

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)
Attempt to handle a consolidated section.

source code
call graph

handle_consolidated_bullet_list(self, items, tagname)

source code
call graph

handle_consolidated_definition_list(self, items, tagname)

source code
call graph

unknown_visit(self, node)
Ignore all unknown nodes

source code
call graph

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

Class Variables

[hide private]

ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD = True
If true, then consolidated fields are not required to mark arguments with `backticks`.

Inherited from docutils.nodes.NodeVisitor: optional

Instance Variables

[hide private]

list of Field 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__

unknown_visit(self, node)

source code
call graph

Ignore all unknown nodes

Overrides: docutils.nodes.NodeVisitor.unknown_visit

Class Variable Details

[hide private]

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.

Value:

True

ClassType _SplitFieldsTranslator

__init__(self, document, errors) (Constructor)

unknown_visit(self, node)

ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD

init(self, document, errors)
(Constructor)