docutils.writers.latex2e.Writer

class documentation

class Writer(writers.Writer): (source)

Known subclasses: docutils.writers.xetex.Writer

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method assemble_parts Assemble the self.parts dictionary of output fragments.
Method get_transforms Transforms required by this class. Override in subclasses.
Method translate Do final translation of self.document into self.output. Called from write. Override in subclasses.
Class Variable config_section The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses.
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 default_preamble Undocumented
Class Variable default_template Undocumented
Class Variable default_template_path Undocumented
Class Variable head_parts Undocumented
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.
Class Variable supported Formats this writer supports.
Class Variable table_style_values Undocumented
Class Variable visitor_attributes Undocumented
Instance Variable output Final translated form of document.
Instance Variable translator_class Undocumented

Inherited from Writer:

Method write Process a document into its final form.
Class Variable component_type Name of the component type ('reader', 'parser', 'writer'). 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 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.

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__
overridden in docutils.writers.xetex.Writer

Undocumented

def assemble_parts(self): (source)
overrides docutils.writers.Writer.assemble_parts

Assemble the self.parts dictionary of output fragments.

def get_transforms(self): (source)
overrides docutils.writers.Writer.get_transforms

Transforms required by this class. Override in subclasses.

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.

config_section: str = (source)
overrides docutils.writers.Writer.config_section
overridden in docutils.writers.xetex.Writer

The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses.

config_section_dependencies: tuple[str, ...] = (source)
overrides docutils.SettingsSpec.config_section_dependencies
overridden in docutils.writers.xetex.Writer

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.

default_preamble = (source)
overridden in docutils.writers.xetex.Writer

Undocumented

default_template: str = (source)
overridden in docutils.writers.xetex.Writer

Undocumented

default_template_path = (source)

Undocumented

head_parts: tuple[str, ...] = (source)

Undocumented

settings_defaults: dict[str, int] = (source)
overrides docutils.SettingsSpec.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.

settings_spec = (source)
overrides docutils.SettingsSpec.settings_spec
overridden in docutils.writers.xetex.Writer

Runtime settings specification. Override in subclasses.

Defines runtime settings and associated command-line options, as used by docutils.frontend.OptionParser. This is a tuple of:

  • Option group title (string or None which implies no group, just a list of single options).

  • Description (string or None).

  • A sequence of option tuples. Each consists of:

    • Help text (string)

    • List of option strings (e.g. ['-Q', '--quux']).

    • Dictionary of keyword arguments sent to the OptionParser/OptionGroup add_option method.

      Runtime setting names are derived implicitly from long option names ('--a-setting' becomes settings.a_setting) or explicitly from the 'dest' keyword argument.

      Most settings will also have a 'validator' keyword & function. The validator function validates setting values (from configuration files and command-line option arguments) and converts them to appropriate types. For example, the docutils.frontend.validate_boolean function, required by all boolean settings, converts true values ('1', 'on', 'yes', and 'true') to 1 and false values ('0', 'off', 'no', 'false', and '') to 0. Validators need only be set once per setting. See the docutils.frontend.validate_* functions.

      See the optparse docs for more details.

  • More triples of group title, description, options, as many times as needed. Thus, settings_spec tuples can be simply concatenated.

supported: tuple[str, ...] = (source)
overrides docutils.Component.supported
overridden in docutils.writers.xetex.Writer

Formats this writer supports.

table_style_values: tuple[str, ...] = (source)

Undocumented

visitor_attributes = (source)

Undocumented

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

Final translated form of document.

translator_class = (source)
overridden in docutils.writers.xetex.Writer

Undocumented