docutils.writers.pep

Package docutils :: Package writers :: Module pep_html :: Class Writer

[show private | hide private]

Class Writer

 SettingsSpec --+            
                |            
TransformSpec --+            
                |            
        Component --+        
                    |        
               Writer --+    
                        |    
                   Writer --+
                            |
                           Writer

Method Summary
	`__init__(self)` Initialize the Writer instance.
	`translate(self)` Override to do final document tree translation.
Inherited from Writer
	`write(self, document, destination)`
Inherited from Component
	`supports(self, format)` Is `format` supported by this component?

Class Variable Summary
`tuple`	`relative_path_settings` = `('pep_stylesheet_path', 'pep_te...`
`dict`	`settings_default_overrides` = `{'footnote_references': 'br...`
`tuple`	`settings_spec` = `('HTML-Specific Options', None, (('Speci...`
Inherited from Writer
`NoneType`	`output` = None
`tuple`	`supported` = `('html', 'html4css1', 'xhtml')`
Inherited from Writer
`str`	`component_type` = `'writer'`
`NoneType`	`destination` = None
`NoneType`	`document` = None
`NoneType`	`language` = None
Inherited from SettingsSpec
`NoneType`	`settings_defaults` = None
Inherited from TransformSpec
`tuple`	`default_transforms` = `()`

Method Details

init(self)
(Constructor)

Initialize the Writer instance.

Overrides:: docutils.writers.html4css1.Writer.__init__ (inherited documentation)

translate(self)

Override to do final document tree translation.

This is 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.html4css1.Writer.translate (inherited documentation)

Class Variable Details

relative_path_settings

Type:: tuple
Value:: ('pep_stylesheet_path', 'pep_template')

settings_default_overrides

Type:: dict
Value:: {'footnote_references': 'brackets'}

settings_spec

Type:: tuple
Value:: ('HTML-Specific Options', None, (('Specify a stylesheet URL, used verbatim. Default is "default.css"\ . Overridden by --stylesheet-path.', ['--stylesheet'], {'default': 'default.css', 'metavar': '<URL>'}), ('Specify a stylesheet file, relative to the current working directo\ ry. The path is adjusted relative to the output HTML file. Overrides\ ...

Generated by Epydoc 2.0 on Tue Jul 22 05:30:18 2003

http://epydoc.sf.net