docutils.readers.doctree.Reader

class documentation

class Reader(readers.ReReader): (source)

Adapt the Reader API for an existing document tree. The existing document tree must be passed as the ``source`` parameter to the `docutils.core.Publisher` initializer, wrapped in a `docutils.io.DocTreeInput` object:: pub = docutils.core.Publisher( ..., source=docutils.io.DocTreeInput(document), ...) The original document settings are overridden; if you want to use the settings of the original document, pass ``settings=document.settings`` to the Publisher call above.

Method	`parse`	No parsing to do; refurbish the document tree instead. Overrides the inherited method.
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	`supported`	Name and aliases for this component. Override in subclasses.
Instance Variable	`document`	Undocumented

Inherited from ReReader:

Method get_transforms Transforms required by this class. Override in subclasses.

Inherited from Reader (via ReReader):

Method	`__init__`	Initialize the Reader instance.
Method	`new_document`	Create and return a new empty document tree (root node).
Method	`read`	Undocumented
Method	`set_parser`	Set `self.parser` by name.
Class Variable	`component_type`	Name of the component type ('reader', 'parser', 'writer'). Override in subclasses.
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 ReReader, Reader):

Method supports Is `format` supported by this component?

Inherited from SettingsSpec (via ReReader, Reader, 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' `setting_specs`. 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 ReReader, Reader, Component):

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.transforms...

def parse(self): (source)

overrides docutils.readers.Reader.parse

No parsing to do; refurbish the document tree instead. Overrides the inherited method.

config_section: str = (source)

overrides docutils.readers.Reader.config_section

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

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.

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

overrides docutils.Component.supported

Name and aliases for this component. Override in subclasses.

document = (source)

overrides docutils.readers.Reader.document

Undocumented