docutils.readers.doctree.Reader Class Reference

Inheritance diagram for docutils.readers.doctree.Reader:

Collaboration diagram for docutils.readers.doctree.Reader:

Public Member Functions
	parse (self)
Public Member Functions inherited from docutils.readers.ReReader
	get_transforms (self)
Public Member Functions inherited from docutils.readers.Reader
	__init__ (self, parser=None, parser_name=None)
	set_parser (self, parser_name)
	read (self, source, parser, settings)
	new_document (self)
Public Member Functions inherited from docutils.Component
	supports (self, format)

Public Attributes
	document
Public Attributes inherited from docutils.readers.Reader
	parser
	source
	input
	settings
	document
Public Attributes inherited from docutils.TransformSpec
	default_transforms

Static Public Attributes
tuple	supported = ('doctree',)
str	config_section = 'doctree reader'
tuple	config_section_dependencies = ('readers',)
Static Public Attributes inherited from docutils.readers.Reader
str	component_type = 'reader'
str	config_section = 'readers'
Static Public Attributes inherited from docutils.Component
	component_type = None
tuple	supported = ()
Static Public Attributes inherited from docutils.SettingsSpec
tuple	settings_spec = ()
	settings_defaults = None
	settings_default_overrides = None
tuple	relative_path_settings = ()
	config_section = None
	config_section_dependencies = None
Static Public Attributes inherited from docutils.TransformSpec
tuple	default_transforms = ()
tuple	unknown_reference_resolvers = ()

Detailed Description

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.

Member Function Documentation

parse()

docutils.readers.doctree.Reader.parse

(

self

)

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

Reimplemented from docutils.readers.Reader.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/readers/doctree.py