docutils.writers.manpage.Writer

class documentation

class Writer(writers.Writer): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method translate Do final translation of self.document into self.output. Called from write. Override in subclasses.
Class Variable supported Formats this writer supports.
Instance Variable output Final translated form of document.
Instance Variable translator_class Undocumented

Inherited from Writer:

Method assemble_parts Assemble the self.parts dictionary. Extend in subclasses.
Method get_transforms Transforms required by this class. Override in subclasses.
Method write Process a document into its final form.
Class Variable component_type Name of the component type ('reader', 'parser', 'writer'). Override in subclasses.
Class Variable config_section The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses.
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 Writer):

Method supports Is format supported by this component?

Inherited from SettingsSpec (via Writer, Component):

Class Variable config_section_dependencies 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 relative_path_settings Settings containing filesystem paths. Override in subclasses. Settings listed here are to be interpreted relative to the current working directory.
Class Variable settings_default_overrides A dictionary of auxiliary defaults, to override defaults for settings defined in other components. Override in subclasses.
Class Variable settings_defaults 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_spec Runtime settings specification. Override in subclasses.

Inherited from TransformSpec (via Writer, Component, SettingsSpec):

Class Variable default_transforms Undocumented
Class Variable unknown_reference_resolvers 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.tranforms.references...
def __init__(self): (source)
overrides docutils.writers.Writer.__init__

Undocumented

def translate(self): (source)
overrides 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.

supported: tuple[str, ...] = (source)
overrides docutils.Component.supported

Formats this writer supports.

output = (source)
overrides docutils.writers.Writer.output

Final translated form of document.

translator_class = (source)

Undocumented