class Writer(writers.UnfilteredWriter): (source)
Undocumented
Method | translate |
Do final translation of `self.document` into `self.output`. Called from `write`. Override in subclasses. |
Class Variable | config |
The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses. |
Class Variable | config |
A list of names of config file sections that are to be applied before `config_section`, in order (from general to specific). In other words, the settings in `config_section` are to be overlaid on top of the settings from these sections... |
Class Variable | supported |
Formats this writer supports. |
Inherited from UnfilteredWriter
:
Method | get |
Transforms required by this class. Override in subclasses. |
Inherited from Writer
(via UnfilteredWriter
):
Method | __init__ |
Undocumented |
Method | assemble |
Assemble the `self.parts` dictionary. Extend in subclasses. |
Method | write |
Process a document into its final form. |
Class Variable | component |
Name of the component type ('reader', 'parser', 'writer'). Override in subclasses. |
Class Variable | output |
Final translated form of `document` (Unicode string for text, binary string for other forms); set by `translate`. |
Instance Variable | destination |
`docutils.io` Output object; where to write the document. Set by `write`. |
Instance Variable | document |
The document to write (Docutils doctree); set by `write`. |
Instance Variable | language |
Language module for the document; set by `write`. |
Instance Variable | parts |
Mapping of document part names to fragments of `self.output`. Values are Unicode strings; encoding is up to the client. The 'whole' key should contain the entire document output. |
Inherited from Component
(via UnfilteredWriter
, Writer
):
Method | supports |
Is `format` supported by this component? |
Inherited from SettingsSpec
(via UnfilteredWriter
, Writer
, Component
):
Class Variable | relative |
Settings containing filesystem paths. Override in subclasses. Settings listed here are to be interpreted relative to the current working directory. |
Class Variable | settings |
A dictionary of auxiliary defaults, to override defaults for settings defined in other components' `setting_specs`. Override in subclasses. |
Class Variable | settings |
A dictionary of defaults for settings not in `settings_spec` (internal settings, intended to be inaccessible by command-line and config file). Override in subclasses. |
Class Variable | settings |
Runtime settings specification. Override in subclasses. |
Inherited from TransformSpec
(via UnfilteredWriter
, Writer
, Component
):
Class Variable | default |
Undocumented |
Class Variable | unknown |
List of functions to try to resolve unknown references. Unknown references have a 'refname' attribute which doesn't correspond to any target in the document. Called when the transforms in `docutils.transforms... |
docutils.writers.Writer.translate
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.
docutils.writers.Writer.config_section
The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses.
A list of names of config file sections that are to be applied before `config_section`, in order (from general to specific). In other words, the settings in `config_section` are to be overlaid on top of the settings from these sections. The "general" section is assumed implicitly. Override in subclasses.