docutils.parsers.rst.states.SpecializedText Class Reference

Inheritance diagram for docutils.parsers.rst.states.SpecializedText:

Collaboration diagram for docutils.parsers.rst.states.SpecializedText:

Public Member Functions
	eof (self, context)
	invalid_input (self, match=None, context=None, next_state=None)
Public Member Functions inherited from docutils.parsers.rst.states.Text
	blank (self, match, context, next_state)
	indent (self, match, context, next_state)
	underline (self, match, context, next_state)
	text (self, match, context, next_state)
	literal_block (self)
	quoted_literal_block (self)
	definition_list_item (self, termline)
	term (self, lines, lineno)
Public Member Functions inherited from docutils.parsers.rst.states.RSTState
	__init__ (self, state_machine, debug=False)
	runtime_init (self)
	goto_line (self, abs_line_offset)
	no_match (self, context, transitions)
	bof (self, context)
	nested_parse (self, block, input_offset, node, match_titles=False, state_machine_class=None, state_machine_kwargs=None)
	nested_list_parse (self, block, input_offset, node, initial_state, blank_finish, blank_finish_state=None, extra_settings={}, match_titles=False, state_machine_class=None, state_machine_kwargs=None)
	section (self, title, source, style, lineno, messages)
	check_subsection (self, source, style, lineno)
	title_inconsistent (self, sourcetext, lineno)
	new_subsection (self, title, lineno, messages)
	paragraph (self, lines, lineno)
	inline_text (self, text, lineno)
	unindent_warning (self, node_name)
Public Member Functions inherited from docutils.statemachine.StateWS
	add_initial_transitions (self)
	known_indent (self, match, context, next_state)
	first_known_indent (self, match, context, next_state)
Public Member Functions inherited from docutils.statemachine.State
	unlink (self)
	add_transitions (self, names, transitions)
	add_transition (self, name, transition)
	remove_transition (self, name)
	make_transition (self, name, next_state=None)
	make_transitions (self, name_list)
	nop (self, match, context, next_state)

Static Public Attributes
	blank = invalid_input
	indent = invalid_input
	underline = invalid_input
	text = invalid_input
Static Public Attributes inherited from docutils.parsers.rst.states.Text
dict	patterns
list	initial_transitions = [('underline', 'Body'), ('text', 'Body')]
	classifier_delimiter = re.compile(' +: +')
Static Public Attributes inherited from docutils.parsers.rst.states.RSTState
	nested_sm = NestedStateMachine
list	nested_sm_cache = []
Static Public Attributes inherited from docutils.statemachine.StateWS
	indent_sm = None
	indent_sm_kwargs = None
	known_indent_sm = None
	known_indent_sm_kwargs = None
dict	ws_patterns
tuple	ws_initial_transitions = ('blank', 'indent')
Static Public Attributes inherited from docutils.statemachine.State
	patterns = None
	initial_transitions = None
	nested_sm = None
	nested_sm_kwargs = None

Additional Inherited Members
Public Attributes inherited from docutils.parsers.rst.states.RSTState
	nested_sm_kwargs
	memo
	reporter
	inliner
	document
	parent
Public Attributes inherited from docutils.statemachine.StateWS
	patterns
	ws_patterns
	ws_initial_transitions
Public Attributes inherited from docutils.statemachine.State
	transition_order
	transitions
	state_machine
	debug

Detailed Description

Superclass for second and subsequent lines of Text-variants.

All transition methods are disabled. Override individual methods in
subclasses to re-enable.

Member Function Documentation

eof()

docutils.parsers.rst.states.SpecializedText.eof	(		self,
			context
	)

Incomplete construct.

Reimplemented from docutils.parsers.rst.states.Text.

Reimplemented in docutils.parsers.rst.states.Definition, and docutils.parsers.rst.states.Line.

invalid_input()

docutils.parsers.rst.states.SpecializedText.invalid_input	(		self,
			match = None,
			context = None,
			next_state = None
	)

Not a compound element member. Abort this state machine.

Member Data Documentation

blank

docutils.parsers.rst.states.SpecializedText.blank = invalid_input

static

Reimplemented in docutils.parsers.rst.states.Line.

indent

docutils.parsers.rst.states.SpecializedText.indent = invalid_input

static

Reimplemented in docutils.parsers.rst.states.Definition.

text

docutils.parsers.rst.states.SpecializedText.text = invalid_input

static

Reimplemented in docutils.parsers.rst.states.Line.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/docutils/parsers/rst/states.py