docutils.parsers.rst.states.SubstitutionDef

Method	`embedded_directive`	Undocumented
Method	`text`	Titles, definition lists, paragraphs.
Class Variable	`initial_transitions`	A list of transitions to initialize when a `State` is instantiated. Each entry is either a transition name string, or a (transition name, next state name) pair. See `make_transitions()`. Override in subclasses.
Class Variable	`patterns`	{Name: pattern} mapping, used by `make_transition()`. Each pattern may be a string or a compiled `re` pattern. Override in subclasses.
Instance Variable	`blank_finish`	Undocumented

Inherited from Body:

Method	`add_target`	Undocumented
Method	`anonymous`	Anonymous hyperlink targets.
Method	`anonymous_target`	Undocumented
Method	`block_quote`	Undocumented
Method	`build_table`	Undocumented
Method	`build_table_row`	Undocumented
Method	`bullet`	Bullet list item.
Method	`check_attribution`	Check attribution shape. Return the index past the end of the attribution, and the indent.
Method	`citation`	Undocumented
Method	`comment`	Undocumented
Method	`directive`	Returns a 2-tuple: list of nodes, and a "blank finish" boolean.
Method	`disallowed_inside_substitution_definitions`	Undocumented
Method	`doctest`	Undocumented
Method	`enumerator`	Enumerated List Item
Method	`explicit_construct`	Determine which explicit construct this is, parse & return it.
Method	`explicit_list`	Create a nested state machine for a series of explicit markup constructs (including anonymous hyperlink targets).
Method	`explicit_markup`	Footnotes, hyperlink targets, directives, comments.
Method	`field`	Undocumented
Method	`field_marker`	Field list item.
Method	`footnote`	Undocumented
Method	`grid_table_top`	Top border of a full table.
Method	`hyperlink_target`	Undocumented
Method	`indent`	Block quote.
Method	`is_enumerated_list_item`	Check validity based on the ordinal value and the second line.
Method	`is_reference`	Undocumented
Method	`isolate_grid_table`	Undocumented
Method	`isolate_simple_table`	Undocumented
Method	`line`	Section title overline or transition marker.
Method	`line_block`	First line of a line block.
Method	`line_block_line`	Return one line element of a line_block.
Method	`list_item`	Undocumented
Method	`make_enumerator`	Construct and return the next enumerated list item marker, and an auto-enumerator ("#" instead of the regular enumerator).
Method	`make_target`	Undocumented
Method	`malformed_table`	Undocumented
Method	`nest_line_block_lines`	Undocumented
Method	`nest_line_block_segment`	Undocumented
Method	`option_list_item`	Undocumented
Method	`option_marker`	Option list item.
Method	`parse_attribution`	Undocumented
Method	`parse_directive_arguments`	Undocumented
Method	`parse_directive_block`	Undocumented
Method	`parse_directive_options`	Undocumented
Method	`parse_enumerator`	Analyze an enumerator and return the results.
Method	`parse_extension_options`	Parse `datalines` for a field list containing extension options matching `option_spec`.
Method	`parse_field_body`	Undocumented
Method	`parse_field_marker`	Extract & return field name from a field marker match.
Method	`parse_option_marker`	Return a list of `node.option` and `node.option_argument` objects, parsed from an option marker match.
Method	`parse_target`	Determine the type of reference of a target.
Method	`run_directive`	Parse a directive then run its directive function.
Method	`simple_table_top`	Top border of a simple table.
Method	`split_attribution`	Check for a block quote attribution and split it off:
Method	`substitution_def`	Undocumented
Method	`table`	Parse a table.
Method	`table_top`	Top border of a generic table.
Method	`unknown_directive`	Undocumented
Class Variable	`attribution_pattern`	Undocumented
Class Variable	`enum`	Enumerated list parsing information.
Class Variable	`explicit`	Patterns and constants used for explicit markup recognition.
Class Variable	`grid_table_top_pat`	Matches the top (& bottom) of a full table).
Class Variable	`pats`	Fragments of patterns used by transitions.
Class Variable	`simple_table_border_pat`	Matches the bottom & header bottom of a simple table.
Class Variable	`simple_table_top_pat`	Matches the top of a simple table.

Inherited from RSTState (via Body):

Method	`__init__`	Initialize a `StateSM` object; extends `State.__init__()`.
Method	`bof`	Called at beginning of file.
Method	`check_subsection`	Check for a valid subsection header. Return True or False.
Method	`goto_line`	Jump to input line `abs_line_offset`, ignoring jumps past the end.
Method	`inline_text`	Return 2 lists: nodes (text and inline elements), and system_messages.
Method	`nested_list_parse`	Create a new StateMachine rooted at `node` and run it over the input `block`. Also keep track of optional intermediate blank lines and the required final one.
Method	`nested_parse`	Create a new StateMachine rooted at `node` and run it over the input `block`.
Method	`new_subsection`	Append new subsection to document tree. On return, check level.
Method	`no_match`	Override `StateWS.no_match` to generate a system message.
Method	`paragraph`	Return a list (paragraph & messages) & a boolean: literal_block next?
Method	`runtime_init`	Initialize this `State` before running the state machine; called from `self.state_machine.run()`.
Method	`section`	Check for a valid subsection and create one if it checks out.
Method	`title_inconsistent`	Undocumented
Method	`unindent_warning`	Undocumented
Class Variable	`nested_sm_cache`	Undocumented
Instance Variable	`document`	Undocumented
Instance Variable	`inliner`	Undocumented
Instance Variable	`memo`	Undocumented
Instance Variable	`nested_sm_kwargs`	Keyword arguments dictionary, passed to the `nested_sm` constructor.
Instance Variable	`parent`	Undocumented
Instance Variable	`reporter`	Undocumented

Inherited from StateWS (via Body, RSTState):

Method	`add_initial_transitions`	Add whitespace-specific transitions before those defined in subclass.
Method	`blank`	Handle blank lines. Does nothing. Override in subclasses.
Method	`first_known_indent`	Handle an indented text block (first line's indent known).
Method	`known_indent`	Handle a known-indent text block. Extend or override in subclasses.
Class Variable	`ws_initial_transitions`	Default initial whitespace transitions, added before those listed in `State.initial_transitions`. May be overridden in subclasses.
Class Variable	`ws_patterns`	Patterns for default whitespace transitions. May be overridden in subclasses.
Instance Variable	`indent_sm`	The `StateMachine` class handling indented text blocks.
Instance Variable	`indent_sm_kwargs`	Keyword arguments dictionary, passed to the `indent_sm` constructor.
Instance Variable	`known_indent_sm`	The `StateMachine` class handling known-indented text blocks.
Instance Variable	`known_indent_sm_kwargs`	Keyword arguments dictionary, passed to the `known_indent_sm` constructor.

Inherited from State (via Body, RSTState, StateWS):

Method	`add_transition`	Add a transition to the start of the transition list.
Method	`add_transitions`	Add a list of transitions to the start of the transition list.
Method	`eof`	Handle end-of-file. Return empty result.
Method	`make_transition`	Make & return a transition tuple based on `name`.
Method	`make_transitions`	Return a list of transition names and a transition mapping.
Method	`nop`	A "do nothing" transition method.
Method	`remove_transition`	Remove a transition by `name`.
Method	`unlink`	Remove circular references to objects no longer required.
Instance Variable	`debug`	Debugging mode on/off.
Instance Variable	`nested_sm`	The `StateMachine` class for handling nested processing.
Instance Variable	`state_machine`	A reference to the controlling `StateMachine` object.
Instance Variable	`transition_order`	A list of transition names in search order.
Instance Variable	`transitions`	No summary