docutils.nodes.document

class documentation

class document(Root, Structural, Element):

The document root element.

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

Method	`__getstate__`	Return dict with unpicklable references removed.
Method	`__init__`	Undocumented
Method	`asdom`	Return a DOM representation of this document.
Method	`copy`	Return a copy of self.
Method	`get_decoration`	Undocumented
Method	`has_name`	Undocumented
Method	`note_anonymous_target`	Undocumented
Method	`note_autofootnote`	Undocumented
Method	`note_autofootnote_ref`	Undocumented
Method	`note_citation`	Undocumented
Method	`note_citation_ref`	Undocumented
Method	`note_explicit_target`	Undocumented
Method	`note_footnote`	Undocumented
Method	`note_footnote_ref`	Undocumented
Method	`note_implicit_target`	Undocumented
Method	`note_indirect_target`	Undocumented
Method	`note_parse_message`	Undocumented
Method	`note_pending`	Undocumented
Method	`note_refid`	Undocumented
Method	`note_refname`	Undocumented
Method	`note_source`	Undocumented
Method	`note_substitution_def`	Undocumented
Method	`note_substitution_ref`	Undocumented
Method	`note_symbol_footnote`	Undocumented
Method	`note_symbol_footnote_ref`	Undocumented
Method	`note_transform_message`	Undocumented
Method	`set_duplicate_name_id`	Undocumented
Method	`set_id`	Undocumented
Method	`set_name_id_map`	`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.
Instance Variable	`autofootnote_refs`	List of auto-numbered footnote_reference nodes.
Instance Variable	`autofootnote_start`	Initial auto-numbered footnote number.
Instance Variable	`autofootnotes`	List of auto-numbered footnote nodes.
Instance Variable	`citation_refs`	Mapping of citation labels to lists of citation_reference nodes.
Instance Variable	`citations`	List of citation nodes.
Instance Variable	`current_line`	Line number (1-based) of `current_source`.
Instance Variable	`current_source`	Path to or description of the input source being processed.
Instance Variable	`decoration`	Document's `decoration` node.
Instance Variable	`footnote_refs`	Mapping of footnote labels to lists of footnote_reference nodes.
Instance Variable	`footnotes`	List of manually-numbered footnote nodes.
Instance Variable	`id_counter`	Numbers added to otherwise identical IDs.
Instance Variable	`ids`	Mapping of ids to nodes.
Instance Variable	`include_log`	The current source's parents (to detect inclusion loops).
Instance Variable	`indirect_targets`	List of indirect target nodes.
Instance Variable	`nameids`	Mapping of names to unique id's.
Instance Variable	`nametypes`	Mapping of names to hyperlink type (boolean: True => explicit, False => implicit.
Instance Variable	`parse_messages`	System messages generated while parsing.
Instance Variable	`refids`	Mapping of ids to lists of referencing nodes.
Instance Variable	`refnames`	Mapping of names to lists of referencing nodes.
Instance Variable	`reporter`	System message generator.
Instance Variable	`settings`	Runtime settings data record.
Instance Variable	`substitution_defs`	Mapping of substitution names to substitution_definition nodes.
Instance Variable	`substitution_names`	Mapping of case-normalized substitution names to case-sensitive names.
Instance Variable	`symbol_footnote_refs`	List of symbol footnote_reference nodes.
Instance Variable	`symbol_footnote_start`	Initial symbol footnote symbol index.
Instance Variable	`symbol_footnotes`	List of symbol footnote nodes.
Instance Variable	`transform_messages`	System messages generated while applying transforms.
Instance Variable	`transformer`	Storage for transforms to be applied to this document.
Instance Variable	`_document`	Undocumented

Inherited from Element:

Class Method	`is_not_known_attribute`	Returns True if and only if the given attribute is NOT recognized by this class.
Class Method	`is_not_list_attribute`	Returns True if and only if the given attribute is NOT one of the basic list attributes defined for all Elements.
Method	`__add__`	Undocumented
Method	`__contains__`	Undocumented
Method	`__delitem__`	Undocumented
Method	`__getitem__`	Undocumented
Method	`__iadd__`	Append a node or a list of nodes to `self.children`.
Method	`__len__`	Undocumented
Method	`__radd__`	Undocumented
Method	`__repr__`	Undocumented
Method	`__setitem__`	Undocumented
Method	`__unicode__`	Undocumented
Method	`append`	Undocumented
Method	`append_attr_list`	For each element in values, if it does not exist in self[attr], append it.
Method	`astext`	Return a string representation of this Node.
Method	`attlist`	Undocumented
Method	`clear`	Undocumented
Method	`coerce_append_attr_list`	First, convert both self[attr] and value to a non-string sequence type; if either is not already a sequence, convert it to a list of one element. Then call append_attr_list.
Method	`copy_attr_coerce`	No summary
Method	`copy_attr_concatenate`	No summary
Method	`copy_attr_consistent`	If replace is True or self[attr] is None, replace self[attr] with value. Otherwise, do nothing.
Method	`copy_attr_convert`	If attr is an attribute of self, set self[attr] to [self[attr], value], otherwise set self[attr] to value.
Method	`deepcopy`	Return a deep copy of self (also copying children).
Method	`delattr`	Undocumented
Method	`emptytag`	Undocumented
Method	`endtag`	Undocumented
Method	`extend`	Undocumented
Method	`first_child_matching_class`	Return the index of the first child whose class exactly matches.
Method	`first_child_not_matching_class`	Return the index of the first child whose class does not match.
Method	`get`	Undocumented
Method	`get_language_code`	Return node's language tag.
Method	`hasattr`	Undocumented
Method	`index`	Undocumented
Method	`insert`	Undocumented
Method	`is_not_default`	Undocumented
Method	`non_default_attributes`	Undocumented
Method	`note_referenced_by`	Note that this Element has been referenced by its name `name` or id `id`.
Method	`pformat`	Return an indented pseudo-XML representation, for test purposes.
Method	`pop`	Undocumented
Method	`remove`	Undocumented
Method	`replace`	Replace one child `Node` with another child or children.
Method	`replace_attr`	If self[attr] does not exist or force is True or omitted, set self[attr] to value, otherwise do nothing.
Method	`replace_self`	Replace `self` node with `new`, where `new` is a node or a list of nodes.
Method	`set_class`	Add a new class to the "classes" attribute.
Method	`setdefault`	Undocumented
Method	`shortrepr`	Undocumented
Method	`starttag`	Undocumented
Method	`update_all_atts`	Updates all attributes from node or dictionary `dict_`.
Method	`update_all_atts_coercion`	Updates all attributes from node or dictionary `dict_`.
Method	`update_all_atts_concatenating`	Updates all attributes from node or dictionary `dict_`.
Method	`update_all_atts_consistantly`	Updates all attributes from node or dictionary `dict_`.
Method	`update_all_atts_convert`	Updates all attributes from node or dictionary `dict_`.
Method	`update_basic_atts`	Update basic attributes ('ids', 'names', 'classes', 'dupnames', but not 'source') from node or dictionary `dict_`.
Class Variable	`basic_attributes`	Tuple of attributes which are defined for every Element-derived class instance and can be safely transferred to a different node.
Class Variable	`child_text_separator`	Separator for child nodes, used by `astext()` method.
Class Variable	`known_attributes`	Tuple of attributes that are known to the Element base class.
Class Variable	`list_attributes`	Tuple of attributes that are automatically initialized to empty lists for all nodes.
Class Variable	`local_attributes`	Tuple of class-specific attributes that should not be copied with the standard attributes when replacing a node.
Instance Variable	`attributes`	Dictionary of attribute {name: value}.
Instance Variable	`children`	List of child nodes (elements and/or `Text`).
Instance Variable	`rawsource`	The raw text from which this element was constructed.
Instance Variable	`referenced`	Undocumented
Instance Variable	`tagname`	The element generic identifier. If None, it is set as an instance attribute to the name of the class.
Method	`_dom_node`	Undocumented

Inherited from Node (via Element):

Method	`__bool__`	Node instances are always true, even if they're empty. A node is more than a simple container. Its boolean "truth" does not depend on having one or more subnodes in the doctree.
Method	`__str__`	Undocumented
Method	`document.setter`	Undocumented
Method	`findall`	Return an iterator yielding nodes following `self`:
Method	`next_node`	Return the first node in the iterator returned by findall(), or None if the iterable is empty.
Method	`previous_sibling`	Return preceding sibling node or `None`.
Method	`setup_child`	Undocumented
Method	`traverse`	Return list of nodes following `self`.
Method	`walk`	No summary
Method	`walkabout`	Perform a tree traversal similarly to `Node.walk()` (which see), except also call the `dispatch_departure()` method before exiting each node.
Class Variable	`line`	The line number (1-based) of the beginning of this Node in `source`.
Class Variable	`parent`	Back-reference to the Node immediately containing this Node.
Class Variable	`source`	Path or description of the input source which generated this Node.
Property	`document`	Return the `document` node at the root of the tree containing this Node.
Method	`_fast_findall`	Return iterator that only supports instance checks.
Method	`_superfast_findall`	Return iterator that doesn't check for a condition.

def __getstate__(self):

Return dict with unpicklable references removed.

def __init__(self, settings, reporter, *args, **kwargs):

overrides docutils.nodes.Element.__init__

Undocumented

def asdom(self, dom=None):

overrides docutils.nodes.Node.asdom

Return a DOM representation of this document.

def copy(self):

overrides docutils.nodes.Element.copy

Return a copy of self.

def get_decoration(self):

Undocumented

def has_name(self, name):

Undocumented

def note_anonymous_target(self, target):

Undocumented

def note_autofootnote(self, footnote):

Undocumented

def note_autofootnote_ref(self, ref):

Undocumented

def note_citation(self, citation):

Undocumented

def note_citation_ref(self, ref):

Undocumented

def note_explicit_target(self, target, msgnode=None):

Undocumented

def note_footnote(self, footnote):

Undocumented

def note_footnote_ref(self, ref):

Undocumented

def note_implicit_target(self, target, msgnode=None):

Undocumented

def note_indirect_target(self, target):

Undocumented

def note_parse_message(self, message):

Undocumented

def note_pending(self, pending, priority=None):

Undocumented

def note_refid(self, node):

Undocumented

def note_refname(self, node):

Undocumented

def note_source(self, source, offset):

Undocumented

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

Undocumented

def note_substitution_ref(self, subref, refname):

Undocumented

def note_symbol_footnote(self, footnote):

Undocumented

def note_symbol_footnote_ref(self, ref):

Undocumented

def note_transform_message(self, message):

Undocumented

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

Undocumented

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

Undocumented

def 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.

autofootnote_refs: list =

List of auto-numbered footnote_reference nodes.

autofootnote_start: int =

Initial auto-numbered footnote number.

autofootnotes: list =

List of auto-numbered footnote nodes.

citation_refs: dict =

Mapping of citation labels to lists of citation_reference nodes.

citations: list =

List of citation nodes.

current_line =

Line number (1-based) of current_source.

current_source =

Path to or description of the input source being processed.

decoration =

Document's decoration node.

footnote_refs: dict =

Mapping of footnote labels to lists of footnote_reference nodes.

footnotes: list =

List of manually-numbered footnote nodes.

id_counter =

Numbers added to otherwise identical IDs.

ids: dict =

Mapping of ids to nodes.

include_log: list =

The current source's parents (to detect inclusion loops).

indirect_targets: list =

List of indirect target nodes.

nameids: dict =

Mapping of names to unique id's.

nametypes: dict =

Mapping of names to hyperlink type (boolean: True => explicit, False => implicit.

parse_messages: list =

System messages generated while parsing.

refids: dict =

Mapping of ids to lists of referencing nodes.

refnames: dict =

Mapping of names to lists of referencing nodes.

reporter =

System message generator.

settings =

Runtime settings data record.

substitution_defs: dict =

Mapping of substitution names to substitution_definition nodes.

substitution_names: dict =

Mapping of case-normalized substitution names to case-sensitive names.

symbol_footnote_refs: list =

List of symbol footnote_reference nodes.

symbol_footnote_start: int =

Initial symbol footnote symbol index.

symbol_footnotes: list =

List of symbol footnote nodes.

transform_messages: list =

System messages generated while applying transforms.

transformer =

Storage for transforms to be applied to this document.

_document =

overrides docutils.nodes.Node._document

Undocumented