Inheritance diagram for docutils.writers.Writer:

Collaboration diagram for docutils.writers.Writer:

Public Member Functions
	get_transforms (self)

	__init__ (self)

	write (self, document, destination)

	translate (self)

	assemble_parts (self)

Public Member Functions inherited from docutils.Component
	supports (self, format)

Public Attributes
	parts

Public Attributes inherited from docutils.TransformSpec
	default_transforms

Static Public Attributes
str	component_type = 'writer'

str	config_section = 'writers'

	document = None

	output = None

	language = None

	destination = None

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

Abstract base class for docutils Writers.

Each writer module or package must export a subclass also called 'Writer'.
Each writer must support all standard node types listed in
`docutils.nodes.node_class_names`.

The `write()` method is the main entry point.

Member Function Documentation

◆ assemble_parts()

docutils.writers.Writer.assemble_parts ( self )

Assemble the `self.parts` dictionary.  Extend in subclasses.

See <https://docutils.sourceforge.io/docs/api/publisher.html>.

Reimplemented in docutils.writers._html_base.Writer, docutils.writers.latex2e.Writer, docutils.writers.odf_odt.Writer, and docutils.writers.pep_html.Writer.

◆ get_transforms()

docutils.writers.Writer.get_transforms ( self )

Transforms required by this class.  Override in subclasses.

Reimplemented from docutils.TransformSpec.

Reimplemented in docutils.writers.UnfilteredWriter, docutils.writers._html_base.Writer, and docutils.writers.latex2e.Writer.

◆ translate()

docutils.writers.Writer.translate ( self )

Do final translation of `self.document` into `self.output`.  Called
from `write`.  Override in subclasses.

Usually done with a `docutils.nodes.NodeVisitor` subclass, in
combination with a call to `docutils.nodes.Node.walk()` or
`docutils.nodes.Node.walkabout()`.  The ``NodeVisitor`` subclass must
support all standard elements (listed in
`docutils.nodes.node_class_names`) and possibly non-standard elements
used by the current Reader as well.

Reimplemented in 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, sphinx.io.SphinxDummyWriter, sphinx.writers.html.HTMLWriter, and sphinx.writers.manpage.ManualPageWriter.

◆ write()

docutils.writers.Writer.write	(	self,
		document,
		destination
	)

Process a document into its final form.

Translate `document` (a Docutils document tree) into the Writer's
native format, and write it out to its `destination` (a
`docutils.io.Output` subclass object).

Normally not overridden or extended in subclasses.

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

docs/help/help-venv/lib/python3.12/site-packages/docutils/writers/__init__.py

Public Member Functions