Classes
class	abbreviation

class	acronym

class	address

class	Admonition

class	admonition

class	attention

class	attribution

class	author

class	authors

class	BackLinkable

class	Bibliographic

class	block_quote

class	Body

class	bullet_list

class	caption

class	caution

class	citation

class	citation_reference

class	classifier

class	colspec

class	comment

class	compound

class	contact

class	container

class	copyright

class	danger

class	date

class	decoration

class	Decorative

class	definition

class	definition_list

class	definition_list_item

class	description

class	docinfo

class	doctest_block

class	document

class	Element

class	emphasis

class	entry

class	enumerated_list

class	error

class	field

class	field_body

class	field_list

class	field_name

class	figure

class	FixedTextElement

class	footer

class	footnote

class	footnote_reference

class	General

class	generated

class	GenericNodeVisitor

class	header

class	hint

class	image

class	important

class	Inline

class	inline

class	Invisible

class	label

class	Labeled

class	legend

class	line

class	line_block

class	list_item

class	literal

class	literal_block

class	math

class	math_block

class	meta

class	Node

class	NodeFound

class	NodeVisitor

class	note

class	option

class	option_argument

class	option_group

class	option_list

class	option_list_item

class	option_string

class	organization

class	paragraph

class	Part

class	pending

class	PreBibliographic

class	problematic

class	raw

class	reference

class	Referential

class	Resolvable

class	revision

class	Root

class	row

class	rubric

class	section

class	Sequential

class	sidebar

class	SkipChildren

class	SkipDeparture

class	SkipNode

class	SkipSiblings

class	SparseNodeVisitor

class	Special

class	status

class	StopTraversal

class	strong

class	Structural

class	subscript

class	substitution_definition

class	substitution_reference

class	subtitle

class	superscript

class	system_message

class	table

class	target

class	Targetable

class	tbody

class	term

class	Text

class	TextElement

class	tgroup

class	thead

class	tip

class	title

class	title_reference

class	Titular

class	topic

class	transition

class	TreeCopyVisitor

class	TreePruningException

class	version

class	warning

Functions
	unescape (text, restore_backslashes=False, respect_whitespace=False)

	_call_default_visit (self, node)

	_call_default_departure (self, node)

	_nop (self, node)

	_add_node_class_names (names)

	make_id (string)

	dupname (node, name)

	fully_normalize_name (name)

	whitespace_normalize_name (name)

	serial_escape (value)

	pseudo_quoteattr (value)

Variables
str	node_class_names

	_non_id_chars = re.compile('[^a-z0-9]+')

	_non_id_at_ends = re.compile('^[-0-9]+\|-+$')

dict	_non_id_translate

dict	_non_id_translate_digraphs

Detailed Description

Docutils document tree element class library.

Classes in CamelCase are abstract base classes or auxiliary classes. The one
exception is `Text`, for a text (PCDATA) node; uppercase is used to
differentiate from element classes.  Classes in lower_case_with_underscores
are element classes, matching the XML element generic identifiers in the DTD_.

The position of each node (the level at which it can occur) is significant and
is represented by abstract base classes (`Root`, `Structural`, `Body`,
`Inline`, etc.).  Certain transformations will be easier because we can use
``isinstance(node, base_class)`` to determine the position of the node in the
hierarchy.

.. _DTD: https://docutils.sourceforge.io/docs/ref/docutils.dtd

Function Documentation

◆ _add_node_class_names()

docutils.nodes._add_node_class_names ( names )

protected

Save typing with dynamic assignments:

◆ fully_normalize_name()

docutils.nodes.fully_normalize_name ( name )

Return a case- and whitespace-normalized name.

◆ make_id()

docutils.nodes.make_id ( string )

Convert `string` into an identifier and return it.

Docutils identifiers will conform to the regular expression
``[a-z](-?[a-z0-9]+)*``.  For CSS compatibility, identifiers (the "class"
and "id" attributes) should have no underscores, colons, or periods.
Hyphens may be used.

- The `HTML 4.01 spec`_ defines identifiers based on SGML tokens:

      ID and NAME tokens must begin with a letter ([A-Za-z]) and may be
      followed by any number of letters, digits ([0-9]), hyphens ("-"),
      underscores ("_"), colons (":"), and periods (".").

- However the `CSS1 spec`_ defines identifiers based on the "name" token,
  a tighter interpretation ("flex" tokenizer notation; "latin1" and
  "escape" 8-bit characters have been replaced with entities)::

      unicode     \\[0-9a-f]{1,4}
      latin1      [&iexcl;-&yuml;]
      escape      {unicode}|\\[ -~&iexcl;-&yuml;]
      nmchar      [-a-z0-9]|{latin1}|{escape}
      name        {nmchar}+

The CSS1 "nmchar" rule does not include underscores ("_"), colons (":"),
or periods ("."), therefore "class" and "id" attributes should not contain
these characters. They should be replaced with hyphens ("-"). Combined
with HTML's requirements (the first character must be a letter; no
"unicode", "latin1", or "escape" characters), this results in the
``[a-z](-?[a-z0-9]+)*`` pattern.

.. _HTML 4.01 spec: https://www.w3.org/TR/html401
.. _CSS1 spec: https://www.w3.org/TR/REC-CSS1

◆ pseudo_quoteattr()

docutils.nodes.pseudo_quoteattr ( value )

Quote attributes for pseudo-xml

◆ serial_escape()

docutils.nodes.serial_escape ( value )

Escape string values that are elements of a list, for serialization.

◆ unescape()

docutils.nodes.unescape	(	text,
		restore_backslashes = `False`,
		respect_whitespace = `False`
	)

Return a string with nulls removed or restored to backslashes.
Backslash-escaped spaces are also removed.

◆ whitespace_normalize_name()

docutils.nodes.whitespace_normalize_name ( name )

Return a whitespace-normalized name.

Variable Documentation

◆ _non_id_translate_digraphs

dict docutils.nodes._non_id_translate_digraphs