class documentation
A reader which rereads an existing document tree (e.g. a deserializer). Often used in conjunction with `writers.UnfilteredWriter`.
Method | get |
Transforms required by this class. Override in subclasses. |
Inherited from Reader
:
Method | __init__ |
Initialize the Reader instance. |
Method | new |
Create and return a new empty document tree (root node). |
Method | parse |
Parse `self.input` into a document tree. |
Method | read |
Undocumented |
Method | set |
Set `self.parser` by name. |
Class Variable | component |
Name of the component type ('reader', 'parser', 'writer'). Override in subclasses. |
Class Variable | config |
The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses. |
Instance Variable | document |
Undocumented |
Instance Variable | input |
Raw text input; either a single string or, for more complex cases, a collection of strings. |
Instance Variable | parser |
A `parsers.Parser` instance shared by all doctrees. May be left unspecified if the document source determines the parser. |
Instance Variable | settings |
Undocumented |
Instance Variable | source |
`docutils.io` IO object, source of input data. |
Inherited from Component
(via Reader
):
Method | supports |
Is `format` supported by this component? |
Class Variable | supported |
Name and aliases for this component. Override in subclasses. |
Inherited from SettingsSpec
(via Reader
, Component
):
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
(via Reader
, 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... |
overrides
docutils.readers.Reader.get_transforms
Transforms required by this class. Override in subclasses.