class Writer(html4css1.Writer): (source)
Undocumented
Method | __init__ |
Undocumented |
Method | assemble |
Assemble the `self.parts` dictionary. Extend in subclasses. |
Method | interpolation |
Undocumented |
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 | default |
Undocumented |
Class Variable | default |
Undocumented |
Class Variable | default |
Undocumented |
Class Variable | default |
Undocumented |
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 |
Runtime settings specification. Override in subclasses. |
Instance Variable | pepnum |
Undocumented |
Instance Variable | title |
Undocumented |
Instance Variable | translator |
Undocumented |
Inherited from Writer
:
Class Variable | default |
Undocumented |
Class Variable | default |
Undocumented |
Class Variable | supported |
Formats this writer supports. |
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 Writer
(via Writer
):
Method | apply |
Undocumented |
Method | get |
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 | 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 | visitor |
Undocumented |
Instance Variable | output |
Final translated form of `document` (Unicode string for text, binary string for other forms); set by `translate`. |
Instance Variable | visitor |
Undocumented |
Inherited from Writer
(via Writer
, Writer
):
Method | write |
Process a document into its final form. |
Class Variable | component |
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`. |
Inherited from Component
(via Writer
, Writer
, Writer
):
Method | supports |
Is `format` supported by this component? |
Inherited from TransformSpec
(via Writer
, Writer
, 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... |
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.
Settings containing filesystem paths. Override in subclasses. Settings listed here are to be interpreted relative to the current working directory.
A dictionary of auxiliary defaults, to override defaults for settings defined in other components' `setting_specs`. Override in subclasses.
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.