epydoc.markup.restructuredtext._DocumentPseudoWriter

ClassType _DocumentPseudoWriter

A pseudo-writer for the docutils framework, that can be used to access the document itself. The output of _DocumentPseudoWriter is just an empty string; but after it has been used, the most recently processed document is available as the instance variable document

Instance Methods

[hide private]

__init__(self)

source code
call graph

translate(self)
Do final translation of self.document into self.output.

source code
call graph

Inherited from docutils.writers.Writer: assemble_parts, get_transforms, write

Inherited from docutils.Component: supports

Class Variables

[hide private]

Inherited from docutils.writers.Writer: component_type, config_section, destination, language, output

Inherited from docutils.Component: supported

Inherited from docutils.SettingsSpec: config_section_dependencies, relative_path_settings, settings_default_overrides, settings_defaults, settings_spec

Inherited from docutils.TransformSpec: default_transforms, unknown_reference_resolvers

Instance Variables

[hide private]

docutils.nodes.document

document
The document to write (Docutils doctree); set by write.

Inherited from docutils.writers.Writer: parts

init(self)
(Constructor)

source code
call graph

Overrides: docutils.writers.Writer.__init__

translate(self)

source code
call graph

Do final translation of self.document into self.output. Called from write. Override in subclasses.

Usually done with a docutils.nodes.NodeVisitor subclass, in combination with a call to docutils.nodes.Node.walk() or docutils.nodes.Node.walkabout(). The NodeVisitor subclass must support all standard elements (listed in docutils.nodes.node\_class\_names) and possibly non-standard elements used by the current Reader as well.

Overrides: docutils.writers.Writer.translate: (inherited documentation)

ClassType _DocumentPseudoWriter

__init__(self) (Constructor)

translate(self)

init(self)
(Constructor)