docutils.writers._html_base.Writer Class Reference

Inheritance diagram for docutils.writers._html_base.Writer:

Collaboration diagram for docutils.writers._html_base.Writer:

Public Member Functions
	get_transforms (self)
	translate (self)
	apply_template (self)
	interpolation_dict (self)
	assemble_parts (self)
Public Member Functions inherited from docutils.writers.Writer
	__init__ (self)
	write (self, document, destination)
Public Member Functions inherited from docutils.Component
	supports (self, format)

Public Attributes
	visitor
	output
Public Attributes inherited from docutils.writers.Writer
	parts
Public Attributes inherited from docutils.TransformSpec
	default_transforms

Static Public Attributes
tuple	supported = ('html', 'xhtml')
tuple	settings_spec
dict	settings_defaults = {'output_encoding_error_handler': 'xmlcharrefreplace'}
tuple	relative_path_settings = ('template',)
str	config_section = 'html base writer'
tuple	config_section_dependencies = ('writers', 'html writers')
tuple	visitor_attributes
Static Public Attributes inherited from docutils.writers.Writer
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 = ()

Member Function Documentation

assemble_parts()

docutils.writers._html_base.Writer.assemble_parts

(

self

)

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

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

Reimplemented from docutils.writers.Writer.

Reimplemented in docutils.writers.pep_html.Writer.

get_transforms()

docutils.writers._html_base.Writer.get_transforms

(

self

)

Transforms required by this class.  Override in subclasses.

Reimplemented from docutils.writers.Writer.

translate()

docutils.writers._html_base.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 from docutils.writers.Writer.

Reimplemented in sphinx.writers.html.HTMLWriter.

Member Data Documentation

visitor_attributes

tuple docutils.writers._html_base.Writer.visitor_attributes

static

Initial value:

=  (
        'head_prefix', 'head', 'stylesheet', 'body_prefix',
        'body_pre_docinfo', 'docinfo', 'body', 'body_suffix',
        'title', 'subtitle', 'header', 'footer', 'meta', 'fragment',
        'html_prolog', 'html_head', 'html_title', 'html_subtitle',
        'html_body')

---

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

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