Inheritance diagram for docutils.nodes.document:

Collaboration diagram for docutils.nodes.document:

Public Member Functions
	__init__ (self, settings, reporter, args, *kwargs)

	__getstate__ (self)

	asdom (self, dom=None)

	set_id (self, node, msgnode=None, suggested_prefix='')

	set_name_id_map (self, node, id, msgnode=None, explicit=None)

	set_duplicate_name_id (self, node, id, name, msgnode, explicit)

	has_name (self, name)

	note_implicit_target (self, target, msgnode=None)

	note_explicit_target (self, target, msgnode=None)

	note_refname (self, node)

	note_refid (self, node)

	note_indirect_target (self, target)

	note_anonymous_target (self, target)

	note_autofootnote (self, footnote)

	note_autofootnote_ref (self, ref)

	note_symbol_footnote (self, footnote)

	note_symbol_footnote_ref (self, ref)

	note_footnote (self, footnote)

	note_footnote_ref (self, ref)

	note_citation (self, citation)

	note_citation_ref (self, ref)

	note_substitution_def (self, subdef, def_name, msgnode=None)

	note_substitution_ref (self, subref, refname)

	note_pending (self, pending, priority=None)

	note_parse_message (self, message)

	note_transform_message (self, message)

	note_source (self, source, offset)

	copy (self)

	get_decoration (self)

Public Member Functions inherited from docutils.nodes.Element
	__repr__ (self)

	shortrepr (self)

	__str__ (self)

	starttag (self, quoteattr=None)

	endtag (self)

	emptytag (self)

	__len__ (self)

	__contains__ (self, key)

	__getitem__ (self, key)

	__setitem__ (self, key, item)

	__delitem__ (self, key)

	__add__ (self, other)

	__radd__ (self, other)

	__iadd__ (self, other)

	astext (self)

	non_default_attributes (self)

	attlist (self)

	get (self, key, failobj=None)

	hasattr (self, attr)

	delattr (self, attr)

	setdefault (self, key, failobj=None)

	get_language_code (self, fallback='')

	append (self, item)

	extend (self, item)

	insert (self, index, item)

	pop (self, i=-1)

	remove (self, item)

	index (self, item, start=0, stop=sys.maxsize)

	previous_sibling (self)

	is_not_default (self, key)

	update_basic_atts (self, dict_)

	append_attr_list (self, attr, values)

	coerce_append_attr_list (self, attr, value)

	replace_attr (self, attr, value, force=True)

	copy_attr_convert (self, attr, value, replace=True)

	copy_attr_coerce (self, attr, value, replace)

	copy_attr_concatenate (self, attr, value, replace)

	copy_attr_consistent (self, attr, value, replace)

	update_all_atts (self, dict_, update_fun=copy_attr_consistent, replace=True, and_source=False)

	update_all_atts_consistantly (self, dict_, replace=True, and_source=False)

	update_all_atts_concatenating (self, dict_, replace=True, and_source=False)

	update_all_atts_coercion (self, dict_, replace=True, and_source=False)

	update_all_atts_convert (self, dict_, and_source=False)

	clear (self)

	replace (self, old, new)

	replace_self (self, new)

	first_child_matching_class (self, childclass, start=0, end=sys.maxsize)

	first_child_not_matching_class (self, childclass, start=0, end=sys.maxsize)

	pformat (self, indent=' ', level=0)

	deepcopy (self)

	set_class (self, name)

	note_referenced_by (self, name=None, id=None)

	is_not_list_attribute (cls, attr)

	is_not_known_attribute (cls, attr)

Public Member Functions inherited from docutils.nodes.Node
	document (self)

	document (self, value)

	__bool__ (self)

	setup_child (self, child)

	walk (self, visitor)

	walkabout (self, visitor)

	traverse (self, condition=None, include_self=True, descend=True, siblings=False, ascend=False)

	findall (self, condition=None, include_self=True, descend=True, siblings=False, ascend=False)

	next_node (self, condition=None, include_self=False, descend=True, siblings=False, ascend=False)

Public Attributes
	current_source

	current_line

	settings

	reporter

	indirect_targets

	substitution_defs

	substitution_names

	refnames

	refids

	nameids

	nametypes

	ids

	footnote_refs

	citation_refs

	autofootnotes

	autofootnote_refs

	symbol_footnotes

	symbol_footnote_refs

	footnotes

	citations

	autofootnote_start

	symbol_footnote_start

	id_counter

	parse_messages

	transform_messages

	transformer

	include_log

	decoration

	attributes

Public Attributes inherited from docutils.nodes.Element
	rawsource

	children

	attributes

	referenced

Public Attributes inherited from docutils.nodes.Node
	children

Protected Attributes
	_document

Additional Inherited Members
Static Public Attributes inherited from docutils.nodes.Element
tuple	basic_attributes = ('ids', 'classes', 'names', 'dupnames')

tuple	local_attributes = ('backrefs',)

tuple	list_attributes = basic_attributes + local_attributes

tuple	known_attributes = list_attributes + ('source',)

	tagname = None

str	child_text_separator = '\n\n'

	has_key = hasattr

Static Public Attributes inherited from docutils.nodes.Node
	parent = None

	source = None

	line = None

Protected Member Functions inherited from docutils.nodes.Element
	_dom_node (self, domroot)

Protected Member Functions inherited from docutils.nodes.Node
	_fast_findall (self, cls)

	_superfast_findall (self)

Static Protected Attributes inherited from docutils.nodes.Node
	_document = None

Detailed Description

The document root element.

Do not instantiate this class directly; use
`docutils.utils.new_document()` instead.

Constructor & Destructor Documentation

◆ init()

docutils.nodes.document.__init__	(		self,
			settings,
			reporter,
		*	args,
		**	kwargs
	)

Reimplemented from docutils.nodes.Element.

Member Function Documentation

◆ getstate()

docutils.nodes.document.__getstate__ ( self )

Return dict with unpicklable references removed.

◆ asdom()

docutils.nodes.document.asdom	(	self,
		dom = `None`
	)

Return a DOM representation of this document.

Reimplemented from docutils.nodes.Node.

◆ copy()

docutils.nodes.document.copy ( self )

Return a copy of self.

Reimplemented from docutils.nodes.Element.

◆ set_name_id_map()

docutils.nodes.document.set_name_id_map	(	self,
		node,
		id,
		msgnode = `None`,
		explicit = `None`
	)

`self.nameids` maps names to IDs, while `self.nametypes` maps names to
booleans representing hyperlink type (True==explicit,
False==implicit).  This method updates the mappings.

The following state transition table shows how `self.nameids` items
("id") and `self.nametypes` items ("type") change with new input
(a call to this method), and what actions are performed
("implicit"-type system messages are INFO/1, and
"explicit"-type system messages are ERROR/3):

====  =====  ========  ========  =======  ====  =====  =====
 Old State    Input          Action        New State   Notes
-----------  --------  -----------------  -----------  -----
id    type   new type  sys.msg.  dupname  id    type
====  =====  ========  ========  =======  ====  =====  =====
-     -      explicit  -         -        new   True
-     -      implicit  -         -        new   False
-     False  explicit  -         -        new   True
old   False  explicit  implicit  old      new   True
-     True   explicit  explicit  new      -     True
old   True   explicit  explicit  new,old  -     True   [#]_
-     False  implicit  implicit  new      -     False
old   False  implicit  implicit  new,old  -     False
-     True   implicit  implicit  new      -     True
old   True   implicit  implicit  new      old   True
====  =====  ========  ========  =======  ====  =====  =====

.. [#] Do not clear the name-to-id map or invalidate the old target if
   both old and new targets are external and refer to identical URIs.
   The new target is invalidated regardless.

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

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

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members