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

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

Public Member Functions
	run (self, input_lines, document, input_offset=0, match_titles=True, inliner=None)

Public Member Functions inherited from docutils.statemachine.StateMachineWS
	get_indented (self, until_blank=False, strip_indent=True)

	get_known_indented (self, indent, until_blank=False, strip_indent=True)

	get_first_known_indented (self, indent, until_blank=False, strip_indent=True, strip_top=True)

Public Member Functions inherited from docutils.statemachine.StateMachine
	__init__ (self, state_classes, initial_state, debug=False)

	unlink (self)

	get_state (self, next_state=None)

	next_line (self, n=1)

	is_next_line_blank (self)

	at_eof (self)

	at_bof (self)

	previous_line (self, n=1)

	goto_line (self, line_offset)

	get_source (self, line_offset)

	abs_line_offset (self)

	abs_line_number (self)

	get_source_and_line (self, lineno=None)

	insert_input (self, input_lines, source)

	get_text_block (self, flush_left=False)

	check_line (self, context, state, transitions=None)

	add_state (self, state_class)

	add_states (self, state_classes)

	runtime_init (self)

	error (self)

	attach_observer (self, observer)

	detach_observer (self, observer)

	notify_observers (self)

Public Attributes
	language

	match_titles

	memo

	document

	reporter

	node

Public Attributes inherited from docutils.statemachine.StateMachineWS
	line_offset

Public Attributes inherited from docutils.statemachine.StateMachine
	input_lines

	input_offset

	line

	line_offset

	debug

	initial_state

	current_state

	states

	observers

Detailed Description

reStructuredText's master StateMachine.

The entry point to reStructuredText parsing is the `run()` method.

Member Function Documentation

docutils.parsers.rst.states.RSTStateMachine.run	(	self,
		input_lines,
		document,
		input_offset = `0`,
		match_titles = `True`,
		inliner = `None`
	)

Parse `input_lines` and modify the `document` node in place.

Extend `StateMachineWS.run()`: set up parse-global data and
run the StateMachine.

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