class documentation
class Component(SettingsSpec, TransformSpec): (source)
Known subclasses: docutils.parsers.Parser
, docutils.readers.Reader
, docutils.writers.Writer
Base class for Docutils components.
Method | supports |
Is `format` supported by this component? |
Class Variable | component |
Name of the component type ('reader', 'parser', 'writer'). Override in subclasses. |
Class Variable | supported |
Name and aliases for this component. Override in subclasses. |
Inherited from SettingsSpec
:
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 | 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
:
Method | get |
Transforms required by this class. Override in subclasses. |
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... |
overridden in
docutils.writers.pseudoxml.Writer
Is `format` supported by this component? To be used by transforms to ask the dependent component if it supports a certain input context or output format.
component_type =
(source)
Name of the component type ('reader', 'parser', 'writer'). Override in subclasses.
overridden in
docutils.parsers.null.Parser
, docutils.parsers.rst.Parser
, docutils.readers.doctree.Reader
, docutils.readers.standalone.Reader
, docutils.writers._html_base.Writer
, docutils.writers.docutils_xml.Writer
, docutils.writers.latex2e.Writer
, docutils.writers.manpage.Writer
, docutils.writers.null.Writer
, docutils.writers.odf_odt.Writer
, docutils.writers.pseudoxml.Writer
Name and aliases for this component. Override in subclasses.