Home       Trees       Index       Help   

epydoc 3.0alpha2

Package epydoc :: Package markup :: Module restructuredtext :: Class _DocumentPseudoWriter
[hide private]
[frames] | no frames]

Class _DocumentPseudoWriter
source code

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)
  translate(self)
Do final translation of self.document into self.output (Unicode string).

Inherited from docutils.writers.Writer: assemble_parts, 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]
document The most recently processed document.

Method Details [hide private]

__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 (Unicode string). 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)

Instance Variable Details [hide private]

document

The most recently processed document.
Type:
docutils.nodes.document

   Home       Trees       Index       Help   

epydoc 3.0alpha2

Generated by Epydoc 3.0alpha2 on Tue Apr 11 17:37:58 2006 http://epydoc.sf.net