configparser.RawConfigParser
docutils.frontend.ConfigParser
- Parser for Docutils configuration files.csv.Dialect
docutils.parsers.rst.directives.tables.CSVTable.DocutilsDialect
- CSV dialect for `csv_table` directive.docutils.parsers.rst.directives.tables.CSVTable.HeaderDialect
- CSV dialect to use for the "header" option data.dict
docutils.writers.latex2e.SortableDict
- Dictionary with additional sorting methodsdocutils.core.Publisher
- A facade encapsulating the high-level logic of a Docutils system.docutils.io.ErrorOutput
- Wrapper class for file-like error streams with failsafe de- and encoding of `str`, `bytes`, `unicode` and `Exception` instances.docutils.languages.LanguageImporter
- Import language modules.docutils.parsers.rst.languages.RstLanguageImporter
- Import language modules.docutils.nodes.BackLinkable
- Undocumenteddocutils.nodes.citation
- Undocumenteddocutils.nodes.footnote
- Undocumenteddocutils.nodes.system_message
- System message element.docutils.nodes.Bibliographic
- Undocumenteddocutils.nodes.address
- Undocumenteddocutils.nodes.author
- Undocumenteddocutils.nodes.authors
- Undocumenteddocutils.nodes.contact
- Undocumenteddocutils.nodes.copyright
- Undocumenteddocutils.nodes.date
- Undocumenteddocutils.nodes.docinfo
- Undocumenteddocutils.nodes.organization
- Undocumenteddocutils.nodes.revision
- Undocumenteddocutils.nodes.status
- Undocumenteddocutils.nodes.version
- Undocumenteddocutils.nodes.Body
- Undocumenteddocutils.nodes.Admonition
- Undocumenteddocutils.nodes.admonition
- Undocumenteddocutils.nodes.attention
- Undocumenteddocutils.nodes.caution
- Undocumenteddocutils.nodes.danger
- Undocumenteddocutils.nodes.error
- Undocumenteddocutils.nodes.hint
- Undocumenteddocutils.nodes.important
- Undocumenteddocutils.nodes.note
- Undocumenteddocutils.nodes.tip
- Undocumenteddocutils.nodes.warning
- Undocumenteddocutils.nodes.General
- Undocumenteddocutils.nodes.block_quote
- Undocumenteddocutils.nodes.citation
- Undocumenteddocutils.nodes.compound
- Undocumenteddocutils.nodes.container
- Undocumenteddocutils.nodes.doctest_block
- Undocumenteddocutils.nodes.figure
- Undocumenteddocutils.nodes.footnote
- Undocumenteddocutils.nodes.image
- Undocumenteddocutils.nodes.line_block
- Undocumenteddocutils.nodes.literal_block
- Undocumenteddocutils.nodes.math_block
- Undocumenteddocutils.nodes.paragraph
- Undocumenteddocutils.nodes.reference
- Undocumenteddocutils.nodes.table
- Undocumenteddocutils.nodes.Sequential
- List-like elements.docutils.nodes.bullet_list
- Undocumenteddocutils.nodes.definition_list
- Undocumenteddocutils.nodes.enumerated_list
- Undocumenteddocutils.nodes.field_list
- Undocumenteddocutils.nodes.option_list
- Undocumenteddocutils.nodes.Special
- Special internal body elements.docutils.nodes.comment
- Undocumenteddocutils.nodes.pending
- The "pending" element is used to encapsulate a pending operation: the operation (transform), the point at which to apply it, and any data it requires. Only the pending operation's location within the document is stored in the public document tree (by the "pending" object itself); the operation and its data are stored in the "pending" object's internal instance attributes.docutils.nodes.raw
- Raw data that is to be passed untouched to the Writer.docutils.nodes.substitution_definition
- Undocumenteddocutils.nodes.system_message
- System message element.docutils.nodes.target
- Undocumenteddocutils.nodes.Inline
- Undocumenteddocutils.nodes.abbreviation
- Undocumenteddocutils.nodes.acronym
- Undocumenteddocutils.nodes.citation_reference
- Undocumenteddocutils.nodes.emphasis
- Undocumenteddocutils.nodes.footnote_reference
- Undocumenteddocutils.nodes.generated
- Undocumenteddocutils.nodes.image
- Undocumenteddocutils.nodes.inline
- Undocumenteddocutils.nodes.literal
- Undocumenteddocutils.nodes.math
- Undocumenteddocutils.nodes.problematic
- Undocumenteddocutils.nodes.raw
- Raw data that is to be passed untouched to the Writer.docutils.nodes.reference
- Undocumenteddocutils.nodes.strong
- Undocumenteddocutils.nodes.subscript
- Undocumenteddocutils.nodes.substitution_reference
- Undocumenteddocutils.nodes.superscript
- Undocumenteddocutils.nodes.target
- Undocumenteddocutils.nodes.title_reference
- Undocumenteddocutils.nodes.Labeled
- Contains a `label` as its first element.docutils.nodes.citation
- Undocumenteddocutils.nodes.footnote
- Undocumenteddocutils.nodes.Node
- Abstract base class of nodes in a document tree.docutils.nodes.Element
- `Element` is the superclass to all specific elements.docutils.nodes.admonition
- Undocumenteddocutils.nodes.attention
- Undocumenteddocutils.nodes.authors
- Undocumenteddocutils.nodes.block_quote
- Undocumenteddocutils.nodes.bullet_list
- Undocumenteddocutils.nodes.caution
- Undocumenteddocutils.nodes.citation
- Undocumenteddocutils.nodes.colspec
- Undocumenteddocutils.nodes.compound
- Undocumenteddocutils.nodes.container
- Undocumenteddocutils.nodes.danger
- Undocumenteddocutils.nodes.decoration
- Undocumenteddocutils.nodes.definition
- Undocumenteddocutils.nodes.definition_list
- Undocumenteddocutils.nodes.definition_list_item
- Undocumenteddocutils.nodes.description
- Undocumenteddocutils.nodes.docinfo
- Undocumenteddocutils.nodes.document
- The document root element.docutils.nodes.entry
- Undocumenteddocutils.nodes.enumerated_list
- Undocumenteddocutils.nodes.error
- Undocumenteddocutils.nodes.field
- Undocumenteddocutils.nodes.field_body
- Undocumenteddocutils.nodes.field_list
- Undocumenteddocutils.nodes.figure
- Undocumenteddocutils.nodes.footer
- Undocumenteddocutils.nodes.footnote
- Undocumenteddocutils.nodes.header
- Undocumenteddocutils.nodes.hint
- Undocumenteddocutils.nodes.image
- Undocumenteddocutils.nodes.important
- Undocumenteddocutils.nodes.legend
- Undocumenteddocutils.nodes.line_block
- Undocumenteddocutils.nodes.list_item
- Undocumenteddocutils.nodes.meta
- Container for "invisible" bibliographic data, or meta-data.docutils.nodes.note
- Undocumenteddocutils.nodes.option
- Undocumenteddocutils.nodes.option_group
- Undocumenteddocutils.nodes.option_list
- Undocumenteddocutils.nodes.option_list_item
- Undocumenteddocutils.nodes.pending
- The "pending" element is used to encapsulate a pending operation: the operation (transform), the point at which to apply it, and any data it requires. Only the pending operation's location within the document is stored in the public document tree (by the "pending" object itself); the operation and its data are stored in the "pending" object's internal instance attributes.docutils.nodes.row
- Undocumenteddocutils.nodes.section
- Undocumenteddocutils.nodes.sidebar
- Sidebars are like miniature, parallel documents that occur inside other documents, providing related or reference material. A sidebar is typically offset by a border and "floats" to the side of the page; the document's main text may flow around it...docutils.nodes.system_message
- System message element.docutils.nodes.table
- Undocumenteddocutils.nodes.tbody
- Undocumenteddocutils.nodes.TextElement
- An element which directly contains text.docutils.nodes.abbreviation
- Undocumenteddocutils.nodes.acronym
- Undocumenteddocutils.nodes.attribution
- Undocumenteddocutils.nodes.author
- Undocumenteddocutils.nodes.caption
- Undocumenteddocutils.nodes.citation_reference
- Undocumenteddocutils.nodes.classifier
- Undocumenteddocutils.nodes.contact
- Undocumenteddocutils.nodes.copyright
- Undocumenteddocutils.nodes.date
- Undocumenteddocutils.nodes.emphasis
- Undocumenteddocutils.nodes.field_name
- Undocumenteddocutils.nodes.FixedTextElement
- An element which directly contains preformatted text.docutils.nodes.address
- Undocumenteddocutils.nodes.comment
- Undocumenteddocutils.nodes.doctest_block
- Undocumenteddocutils.nodes.literal_block
- Undocumenteddocutils.nodes.math_block
- Undocumenteddocutils.nodes.raw
- Raw data that is to be passed untouched to the Writer.docutils.nodes.footnote_reference
- Undocumenteddocutils.nodes.generated
- Undocumenteddocutils.nodes.inline
- Undocumenteddocutils.nodes.label
- Undocumenteddocutils.nodes.line
- Undocumenteddocutils.nodes.literal
- Undocumenteddocutils.nodes.math
- Undocumenteddocutils.nodes.option_argument
- Undocumenteddocutils.nodes.option_string
- Undocumenteddocutils.nodes.organization
- Undocumenteddocutils.nodes.paragraph
- Undocumenteddocutils.nodes.problematic
- Undocumenteddocutils.nodes.reference
- Undocumenteddocutils.nodes.revision
- Undocumenteddocutils.nodes.rubric
- Undocumenteddocutils.nodes.status
- Undocumenteddocutils.nodes.strong
- Undocumenteddocutils.nodes.subscript
- Undocumenteddocutils.nodes.substitution_definition
- Undocumenteddocutils.nodes.substitution_reference
- Undocumenteddocutils.nodes.subtitle
- Undocumenteddocutils.nodes.superscript
- Undocumenteddocutils.nodes.target
- Undocumenteddocutils.nodes.term
- Undocumenteddocutils.nodes.title
- Undocumenteddocutils.nodes.title_reference
- Undocumenteddocutils.nodes.version
- Undocumenteddocutils.nodes.tgroup
- Undocumenteddocutils.nodes.thead
- Undocumenteddocutils.nodes.tip
- Undocumenteddocutils.nodes.topic
- Topics are terminal, "leaf" mini-sections, like block quotes with titles, or textual figures. A topic is just like a section, except that it has no subsections, and it doesn't have to conform to section placement rules.docutils.nodes.transition
- Undocumenteddocutils.nodes.warning
- Undocumenteddocutils.nodes.Text
- Instances are terminal nodes (leaves) containing text only; no child nodes or attributes. Initialize by passing a string to the constructor.docutils.nodes.NodeVisitor
- "Visitor" pattern [GoF95]_ abstract superclass implementation for document tree traversals.docutils.nodes.GenericNodeVisitor
- Generic "Visitor" abstract superclass, for simple traversals.docutils.nodes.TreeCopyVisitor
- Make a complete copy of a tree or branch, including element attributes.docutils.transforms.parts.ContentsFilter
- Undocumenteddocutils.writers._html_base.SimpleListChecker
- Raise `nodes.NodeFound` if non-simple list item is encountered.docutils.writers.html4css1.SimpleListChecker
- Raise `nodes.NodeFound` if non-simple list item is encountered.docutils.writers.docutils_xml.XMLTranslator
- No class docstring; 0/10 instance variable, 1/5 class variable, 2/6 methods documenteddocutils.writers.odf_odt.ODFTranslator
- No class docstring; 0/59 instance variable, 0/6 class variable, 8/241 methods documenteddocutils.nodes.SparseNodeVisitor
- Base class for sparse traversals, where only certain node types are of interest. When ``visit_...`` & ``depart_...`` methods should be implemented for *all* node types (such as for `docutils.writers.Writer` subclasses), subclass `NodeVisitor` instead.docutils.transforms.peps.PEPZeroSpecial
- Perform the special processing needed by PEP 0:docutils.transforms.references.DanglingReferencesVisitor
- Undocumenteddocutils.writers._html_base.HTMLTranslator
- Generic Docutils to HTML translator.docutils.writers.html4css1.HTMLTranslator
- The html4css1 writer has been optimized to produce visually compact lists (less vertical whitespace). HTML's mixed content models allow list items to contain "<li><p>body elements</p></li>" or "<li>just text</li>" or even "<li>text<p>and body elements</p>combined</li>", each with different effects...docutils.writers.pep_html.HTMLTranslator
- Undocumenteddocutils.writers.s5_html.S5HTMLTranslator
- No class docstring; 0/5 instance variable, 5/9 class variables, 2/10 methods documenteddocutils.writers.html5_polyglot.HTMLTranslator
- This writer generates `polyglot markup`: HTML5 that is also valid XML.docutils.writers.latex2e.LaTeXTranslator
- Generate code for 8-bit LaTeX from a Docutils document tree.docutils.writers.xetex.XeLaTeXTranslator
- Generate code for LaTeX using Unicode fonts (XeLaTex or LuaLaTeX).docutils.writers.manpage.Translator
- docutils.nodes.Part
- Undocumenteddocutils.nodes.attribution
- Undocumenteddocutils.nodes.caption
- Undocumenteddocutils.nodes.classifier
- Undocumenteddocutils.nodes.colspec
- Undocumenteddocutils.nodes.definition
- Undocumenteddocutils.nodes.definition_list_item
- Undocumenteddocutils.nodes.description
- Undocumenteddocutils.nodes.entry
- Undocumenteddocutils.nodes.field
- Undocumenteddocutils.nodes.field_body
- Undocumenteddocutils.nodes.field_name
- Undocumenteddocutils.nodes.label
- Undocumenteddocutils.nodes.legend
- Undocumenteddocutils.nodes.line
- Undocumenteddocutils.nodes.list_item
- Undocumenteddocutils.nodes.option
- Undocumenteddocutils.nodes.option_argument
- Undocumenteddocutils.nodes.option_group
- Undocumenteddocutils.nodes.option_list_item
- Undocumenteddocutils.nodes.option_string
- Undocumenteddocutils.nodes.row
- Undocumenteddocutils.nodes.tbody
- Undocumenteddocutils.nodes.term
- Undocumenteddocutils.nodes.tgroup
- Undocumenteddocutils.nodes.thead
- Undocumenteddocutils.nodes.PreBibliographic
- Category of Node which may occur before Bibliographic Nodes.docutils.nodes.Decorative
- Undocumenteddocutils.nodes.decoration
- Undocumenteddocutils.nodes.footer
- Undocumenteddocutils.nodes.header
- Undocumenteddocutils.nodes.Invisible
- Internal elements that don't appear in output.docutils.nodes.comment
- Undocumenteddocutils.nodes.pending
- The "pending" element is used to encapsulate a pending operation: the operation (transform), the point at which to apply it, and any data it requires. Only the pending operation's location within the document is stored in the public document tree (by the "pending" object itself); the operation and its data are stored in the "pending" object's internal instance attributes.docutils.nodes.substitution_definition
- Undocumenteddocutils.nodes.target
- Undocumenteddocutils.nodes.meta
- Container for "invisible" bibliographic data, or meta-data.docutils.nodes.raw
- Raw data that is to be passed untouched to the Writer.docutils.nodes.subtitle
- Undocumenteddocutils.nodes.system_message
- System message element.docutils.nodes.title
- Undocumenteddocutils.nodes.Resolvable
- Undocumenteddocutils.nodes.Referential
- Undocumenteddocutils.nodes.citation_reference
- Undocumenteddocutils.nodes.footnote_reference
- Undocumenteddocutils.nodes.reference
- Undocumenteddocutils.nodes.Targetable
- No class docstring; 1/2 class variable documenteddocutils.nodes.citation
- Undocumenteddocutils.nodes.footnote
- Undocumenteddocutils.nodes.target
- Undocumenteddocutils.nodes.Root
- Undocumenteddocutils.nodes.document
- The document root element.docutils.nodes.Structural
- Undocumenteddocutils.nodes.document
- The document root element.docutils.nodes.section
- Undocumenteddocutils.nodes.sidebar
- Sidebars are like miniature, parallel documents that occur inside other documents, providing related or reference material. A sidebar is typically offset by a border and "floats" to the side of the page; the document's main text may flow around it...docutils.nodes.topic
- Topics are terminal, "leaf" mini-sections, like block quotes with titles, or textual figures. A topic is just like a section, except that it has no subsections, and it doesn't have to conform to section placement rules.docutils.nodes.transition
- Undocumenteddocutils.nodes.Titular
- Undocumenteddocutils.nodes.rubric
- Undocumenteddocutils.nodes.subtitle
- Undocumenteddocutils.nodes.title
- Undocumenteddocutils.parsers.recommonmark_wrapper.addnodes
- Undocumenteddocutils.parsers.rst.Directive
- Base class for reStructuredText directives.docutils.parsers.rst.directives.admonitions.BaseAdmonition
- No class docstring; 1/4 class variable, 0/1 method documenteddocutils.parsers.rst.directives.admonitions.Admonition
- Undocumenteddocutils.parsers.rst.directives.admonitions.Attention
- Undocumenteddocutils.parsers.rst.directives.admonitions.Caution
- Undocumenteddocutils.parsers.rst.directives.admonitions.Danger
- Undocumenteddocutils.parsers.rst.directives.admonitions.Error
- Undocumenteddocutils.parsers.rst.directives.admonitions.Hint
- Undocumenteddocutils.parsers.rst.directives.admonitions.Important
- Undocumenteddocutils.parsers.rst.directives.admonitions.Note
- Undocumenteddocutils.parsers.rst.directives.admonitions.Tip
- Undocumenteddocutils.parsers.rst.directives.admonitions.Warning
- Undocumenteddocutils.parsers.rst.directives.body.BasePseudoSection
- No class docstring; 1/6 class variable, 0/1 method documenteddocutils.parsers.rst.directives.body.Sidebar
- Undocumenteddocutils.parsers.rst.directives.body.Topic
- Undocumenteddocutils.parsers.rst.directives.body.BlockQuote
- Undocumenteddocutils.parsers.rst.directives.body.Epigraph
- Undocumenteddocutils.parsers.rst.directives.body.Highlights
- Undocumenteddocutils.parsers.rst.directives.body.PullQuote
- Undocumenteddocutils.parsers.rst.directives.body.CodeBlock
- Parse and mark up content of a code block.docutils.parsers.rst.directives.body.Compound
- Undocumenteddocutils.parsers.rst.directives.body.Container
- Undocumenteddocutils.parsers.rst.directives.body.LineBlock
- Undocumenteddocutils.parsers.rst.directives.body.MathBlock
- Undocumenteddocutils.parsers.rst.directives.body.ParsedLiteral
- Undocumenteddocutils.parsers.rst.directives.body.Rubric
- Undocumenteddocutils.parsers.rst.directives.images.Image
- Undocumenteddocutils.parsers.rst.directives.images.Figure
- Undocumenteddocutils.parsers.rst.directives.misc.Class
- Set a "class" attribute on the directive content or the next element. When applied to the next element, a "pending" element is inserted, and a transform does the work later.docutils.parsers.rst.directives.misc.Date
- Undocumenteddocutils.parsers.rst.directives.misc.DefaultRole
- Set the default interpreted text role.docutils.parsers.rst.directives.misc.Include
- Include content read from a separate source file.docutils.parsers.rst.directives.misc.Meta
- Undocumenteddocutils.parsers.rst.directives.misc.Raw
- Pass through content unchangeddocutils.parsers.rst.directives.misc.Replace
- Undocumenteddocutils.parsers.rst.directives.misc.Role
- No class docstring; 0/2 class variable, 1/1 method documenteddocutils.parsers.rst.directives.misc.TestDirective
- This directive is useful only for testing purposes.docutils.parsers.rst.directives.misc.Title
- Undocumenteddocutils.parsers.rst.directives.misc.Unicode
- Convert Unicode character codes (numbers) to characters. Codes may be decimal numbers, hexadecimal numbers (prefixed by ``0x``, ``x``, ``\x``, ``U+``, ``u``, or ``\u``; e.g. ``U+262E``), or XML-style numeric character entities (e...docutils.parsers.rst.directives.parts.Contents
- Table of contents.docutils.parsers.rst.directives.parts.Footer
- Contents of document footer.docutils.parsers.rst.directives.parts.Header
- Contents of document header.docutils.parsers.rst.directives.parts.Sectnum
- Automatic section numbering.docutils.parsers.rst.directives.references.TargetNotes
- Target footnote generation.docutils.parsers.rst.directives.tables.Table
- Generic table base class.docutils.parsers.rst.directives.tables.CSVTable
- No class docstring; 0/1 class variable, 1/4 method, 0/2 static method, 2/2 classes documenteddocutils.parsers.rst.directives.tables.ListTable
- Implement tables whose data is encoded as a uniform two-level bullet list. For further ideas, see https://docutils.sourceforge.io/docs/dev/rst/alternatives.html#list-driven-tablesdocutils.parsers.rst.directives.tables.RSTTable
- Undocumenteddocutils.parsers.rst.directives.images.PIL
- Undocumenteddocutils.parsers.rst.roles.CustomRole
- Wrapper for custom interpreted text roles.docutils.parsers.rst.roles.GenericRole
- Generic interpreted text role.docutils.parsers.rst.states.Inliner
- Parse inline markup; call the `parse()` method.docutils.parsers.rst.states.Struct
- Stores data attributes for dotted-attribute access.docutils.parsers.rst.tableparser.TableParser
- Abstract superclass for the common parts of the syntax-specific parsers.docutils.parsers.rst.tableparser.GridTableParser
- Parse a grid table using `parse()`.docutils.parsers.rst.tableparser.SimpleTableParser
- Parse a simple table using `parse()`.docutils.SettingsSpec
- Runtime setting specification base class.docutils.__main__.CliSettingsSpec
- Runtime settings & command-line options for the generic CLI.docutils.Component
- Base class for Docutils components.docutils.parsers.Parser
- No class docstring; 0/2 instance variable, 0/3 class variable, 3/3 methods documenteddocutils.parsers.null.Parser
- A do-nothing parser.docutils.parsers.rst.Parser
- The reStructuredText parser.docutils.readers.Reader
- Abstract base class for docutils Readers.docutils.readers.ReReader
- A reader which rereads an existing document tree (e.g. a deserializer).docutils.readers.doctree.Reader
- Adapt the Reader API for an existing document tree.docutils.readers.standalone.Reader
- No class docstring; 2/5 class variables, 0/1 method documenteddocutils.readers.pep.Reader
- No class docstring; 1/5 class variable, 1/2 method documenteddocutils.writers.odf_odt.Reader
- Undocumenteddocutils.writers.Writer
- Abstract base class for docutils Writers.docutils.writers._html_base.Writer
- No class docstring; 0/2 instance variable, 1/6 class variable, 0/5 method documenteddocutils.writers.html4css1.Writer
- No class docstring; 0/2 instance variable, 1/6 class variable, 0/1 method documenteddocutils.writers.pep_html.Writer
- Undocumenteddocutils.writers.s5_html.Writer
- Undocumenteddocutils.writers.html5_polyglot.Writer
- No class docstring; 0/2 instance variable, 1/6 class variable, 0/1 method documenteddocutils.writers.docutils_xml.Writer
- No class docstring; 1/3 instance variable, 1/5 class variable, 0/2 method documenteddocutils.writers.latex2e.Writer
- No class docstring; 1/2 instance variable, 1/11 class variable, 1/4 method documenteddocutils.writers.xetex.Writer
- A writer for Unicode-aware LaTeX variants (XeTeX, LuaTeX)docutils.writers.manpage.Writer
- No class docstring; 1/2 instance variable, 1/1 class variable, 0/2 method documenteddocutils.writers.odf_odt.Writer
- No class docstring; 0/4 instance variable, 1/10 class variable, 0/2 constant, 5/12 methods documenteddocutils.writers.pseudoxml.Writer
- No class docstring; 1/1 instance variable, 1/4 class variable, 1/2 method documenteddocutils.writers.UnfilteredWriter
- A writer that passes the document tree on unchanged (e.g. a serializer.)docutils.writers.null.Writer
- No class docstring; 1/3 class variable, 0/1 method documenteddocutils.frontend.OptionParser
- Settings parser for command-line and library use.docutils.statemachine._SearchOverride
- Mix-in class to override `StateMachine` regular expression behavior.docutils.statemachine.SearchStateMachine
- `StateMachine` which uses `re.search()` instead of `re.match()`.docutils.statemachine.SearchStateMachineWS
- `StateMachineWS` which uses `re.search()` instead of `re.match()`.docutils.statemachine.State
- State superclass. Contains a list of transitions, and transition methods.docutils.statemachine.StateWS
- State superclass specialized for whitespace (blank lines & indents).docutils.parsers.rst.states.RSTState
- reStructuredText State superclass.docutils.parsers.rst.states.Body
- Generic classifier of the first line of a block.docutils.parsers.rst.states.RFC2822Body
- RFC2822 headers are only valid as the first constructs in documents. As soon as anything else appears, the `Body` state should take over.docutils.parsers.rst.states.RFC2822List
- Second and subsequent RFC2822-style field_list fields.docutils.parsers.rst.states.SpecializedBody
- Superclass for second and subsequent compound element members. Compound elements are lists and list-like constructs.docutils.parsers.rst.directives.misc.MetaBody
- No class docstring; 1/2 method documenteddocutils.parsers.rst.states.BulletList
- Second and subsequent bullet_list list_items.docutils.parsers.rst.states.DefinitionList
- Second and subsequent definition_list_items.docutils.parsers.rst.states.EnumeratedList
- Second and subsequent enumerated_list list_items.docutils.parsers.rst.states.Explicit
- Second and subsequent explicit markup construct.docutils.parsers.rst.states.FieldList
- Second and subsequent field_list fields.docutils.parsers.rst.states.ExtensionOptions
- Parse field_list fields for extension options.docutils.parsers.rst.states.LineBlock
- Second and subsequent lines of a line_block.docutils.parsers.rst.states.OptionList
- Second and subsequent option_list option_list_items.docutils.parsers.rst.states.RFC2822List
- Second and subsequent RFC2822-style field_list fields.docutils.parsers.rst.states.SubstitutionDef
- Parser for the contents of a substitution_definition element.docutils.parsers.rst.states.QuotedLiteralBlock
- Nested parse handler for quoted (unindented) literal blocks.docutils.parsers.rst.states.Text
- Classifier of second line of a text block.docutils.parsers.rst.states.SpecializedText
- Superclass for second and subsequent lines of Text-variants.docutils.parsers.rst.states.Definition
- Second line of potential definition_list_item.docutils.parsers.rst.states.Line
- Second line of over- & underlined section title or transition marker.docutils.statemachine.StateMachine
- A finite state machine for text filters using regular expressions.docutils.statemachine.SearchStateMachine
- `StateMachine` which uses `re.search()` instead of `re.match()`.docutils.statemachine.StateMachineWS
- `StateMachine` subclass specialized for whitespace recognition.docutils.parsers.rst.states.NestedStateMachine
- StateMachine run from within other StateMachine runs, to parse nested document structures.docutils.parsers.rst.states.RSTStateMachine
- reStructuredText's master StateMachine.docutils.statemachine.SearchStateMachineWS
- `StateMachineWS` which uses `re.search()` instead of `re.match()`.docutils.statemachine.ViewList
- List with extended functionality: slices of ViewList objects are child lists, linked to their parents. Changes made to a child list also affect the parent list. A child list is effectively a "view" (in the SQL sense) of the parent list...docutils.statemachine.StringList
- A `ViewList` with string-specific methods.docutils.transforms.Transform
- Docutils transform component abstract base class.docutils.transforms.components.Filter
- Include or exclude elements which depend on a specific Docutils component.docutils.transforms.frontmatter.DocInfo
- This transform is specific to the reStructuredText_ markup syntax; see "Bibliographic Fields" in the `reStructuredText Markup Specification`_ for a high-level description. This transform should be run *after* the `DocTitle` transform.docutils.transforms.frontmatter.TitlePromoter
- Abstract base class for DocTitle and SectionSubTitle transforms.docutils.transforms.frontmatter.DocTitle
- In reStructuredText_, there is no way to specify a document title and subtitle explicitly. Instead, we can supply the document title (and possibly the subtitle as well) implicitly, and use this two-step transform to "raise" or "promote" the title(s) (and their corresponding section contents) to the document level.docutils.transforms.frontmatter.SectionSubTitle
- This works like document subtitles, but for sections. For example, ::docutils.transforms.misc.CallBack
- Inserts a callback into a document. The callback is called when the transform is applied, which is determined by its priority.docutils.transforms.misc.ClassAttribute
- Move the "class" attribute specified in the "pending" node into the immediately following non-comment element.docutils.transforms.misc.Transitions
- Move transitions at the end of sections up the tree. Complain on transitions after a title, at the beginning or end of the document, and after another transition.docutils.transforms.parts.Contents
- This transform generates a table of contents from the entire document tree or from a single branch. It locates "section" elements and builds them into a nested bullet list, which is placed within a "topic" created by the contents directive...docutils.transforms.parts.SectNum
- Automatically assigns numbers to the titles of document sections.docutils.transforms.peps.Contents
- Insert an empty table of contents topic and a transform placeholder into the document after the RFC 2822 header.docutils.transforms.peps.Headers
- Process fields in a PEP's initial RFC-2822 header.docutils.transforms.peps.PEPZero
- Special processing for PEP 0.docutils.transforms.peps.TargetNotes
- Locate the "References" section, insert a placeholder for an external target footnote insertion transform at the end, and schedule the transform to run immediately.docutils.transforms.references.AnonymousHyperlinks
- Link anonymous references to targets. Given::docutils.transforms.references.DanglingReferences
- Check for dangling references (incl. footnote & citation) and for unreferenced targets.docutils.transforms.references.ExternalTargets
- Given::docutils.transforms.references.Footnotes
- Assign numbers to autonumbered footnotes, and resolve links to footnotes, citations, and their references.docutils.transforms.references.IndirectHyperlinks
- a) Indirect external references::docutils.transforms.references.InternalTargets
- No class docstring; 0/1 class variable, 1/2 method documenteddocutils.transforms.references.PropagateTargets
- Propagate empty internal targets to the next element.docutils.transforms.references.Substitutions
- Given the following ``document`` as input::docutils.transforms.references.TargetNotes
- Creates a footnote for each external target in the text, and corresponding footnote references after each reference.docutils.transforms.universal.Decorations
- Populate a document's decoration element (header, footer).docutils.transforms.universal.ExposeInternals
- Expose internal attributes if ``expose_internals`` setting is set.docutils.transforms.universal.FilterMessages
- Remove system messages below verbosity threshold.docutils.transforms.universal.Messages
- Place any system messages generated after parsing into a dedicated section of the document.docutils.transforms.universal.SmartQuotes
- Replace ASCII quotation marks with typographic form.docutils.transforms.universal.StripClassesAndElements
- Remove from the document tree all elements with classes in `self.document.settings.strip_elements_with_classes` and all "classes" attribute values in `self.document.settings.strip_classes`.docutils.transforms.universal.StripComments
- Remove comment elements from the document tree (only if the ``strip_comments`` setting is enabled).docutils.transforms.universal.TestMessages
- Append all post-parse system messages to the end of the document.docutils.transforms.writer_aux.Admonitions
- Transform specific admonitions, like this:docutils.transforms.writer_aux.Compound
- .. warning:: This transform is not used by Docutils since Dec 2010 and will be removed in Docutils 0.21 or later.docutils.TransformSpec
- Runtime transform specification base class.docutils.Component
- Base class for Docutils components.docutils.parsers.Parser
- No class docstring; 0/2 instance variable, 0/3 class variable, 3/3 methods documenteddocutils.parsers.null.Parser
- A do-nothing parser.docutils.parsers.rst.Parser
- The reStructuredText parser.docutils.readers.Reader
- Abstract base class for docutils Readers.docutils.readers.ReReader
- A reader which rereads an existing document tree (e.g. a deserializer).docutils.readers.doctree.Reader
- Adapt the Reader API for an existing document tree.docutils.readers.standalone.Reader
- No class docstring; 2/5 class variables, 0/1 method documenteddocutils.readers.pep.Reader
- No class docstring; 1/5 class variable, 1/2 method documenteddocutils.writers.odf_odt.Reader
- Undocumenteddocutils.writers.Writer
- Abstract base class for docutils Writers.docutils.writers._html_base.Writer
- No class docstring; 0/2 instance variable, 1/6 class variable, 0/5 method documenteddocutils.writers.html4css1.Writer
- No class docstring; 0/2 instance variable, 1/6 class variable, 0/1 method documenteddocutils.writers.pep_html.Writer
- Undocumenteddocutils.writers.s5_html.Writer
- Undocumenteddocutils.writers.html5_polyglot.Writer
- No class docstring; 0/2 instance variable, 1/6 class variable, 0/1 method documenteddocutils.writers.docutils_xml.Writer
- No class docstring; 1/3 instance variable, 1/5 class variable, 0/2 method documenteddocutils.writers.latex2e.Writer
- No class docstring; 1/2 instance variable, 1/11 class variable, 1/4 method documenteddocutils.writers.xetex.Writer
- A writer for Unicode-aware LaTeX variants (XeTeX, LuaTeX)docutils.writers.manpage.Writer
- No class docstring; 1/2 instance variable, 1/1 class variable, 0/2 method documenteddocutils.writers.odf_odt.Writer
- No class docstring; 0/4 instance variable, 1/10 class variable, 0/2 constant, 5/12 methods documenteddocutils.writers.pseudoxml.Writer
- No class docstring; 1/1 instance variable, 1/4 class variable, 1/2 method documenteddocutils.writers.UnfilteredWriter
- A writer that passes the document tree on unchanged (e.g. a serializer.)docutils.writers.null.Writer
- No class docstring; 1/3 class variable, 0/1 method documenteddocutils.io.Input
- Abstract base class for input wrappers.docutils.io.DocTreeInput
- Adapter for document tree input.docutils.io.FileInput
- Input for single, simple file-like objects.docutils.io.NullInput
- Degenerate input: read nothing.docutils.io.StringInput
- Direct string input.docutils.io.Output
- Abstract base class for output wrappers.docutils.io.FileOutput
- Output for single, simple file-like objects.docutils.io.BinaryFileOutput
- A version of docutils.io.FileOutput which writes to a binary file.docutils.io.NullOutput
- Degenerate output: write nothing.docutils.io.StringOutput
- Direct string output.docutils.transforms.Transformer
- Stores transforms (`Transform` classes) and applies them to document trees. Also keeps track of components by component type name.docutils.utils.code_analyzer.Lexer
- Parse `code` lines and yield "classified" tokens.docutils.utils.code_analyzer.NumberLines
- Insert linenumber-tokens at the start of every code line.docutils.utils.DependencyList
- List of dependencies, with file recording support.docutils.utils.error_reporting.ErrorOutput
- Wrapper class for file-like error streams with failsafe de- and encoding of `str`, `bytes`, `unicode` and `Exception` instances.docutils.utils.error_reporting.SafeString
- A wrapper providing robust conversion to `str` and `unicode`.docutils.utils.error_reporting.ErrorString
- Safely report exception type and message.docutils.utils.math.latex2mathml.math
- Base class for MathML elements and root of MathML trees.docutils.utils.math.latex2mathml.MathRowSchema
- Base class for elements treating content as a single inferred mrow.docutils.utils.math.latex2mathml.menclose
- Undocumenteddocutils.utils.math.latex2mathml.mphantom
- Undocumenteddocutils.utils.math.latex2mathml.msqrt
- Undocumenteddocutils.utils.math.latex2mathml.mstyle
- Undocumenteddocutils.utils.math.latex2mathml.mtd
- Undocumenteddocutils.utils.math.latex2mathml.mtr
- Undocumenteddocutils.utils.math.latex2mathml.MathSchema
- Base class for schemata expecting 2 or more children.docutils.utils.math.latex2mathml.mroot
- Undocumenteddocutils.utils.math.latex2mathml.msub
- Undocumenteddocutils.utils.math.latex2mathml.munder
- Undocumenteddocutils.utils.math.latex2mathml.msubsup
- Undocumenteddocutils.utils.math.latex2mathml.munderover
- Undocumenteddocutils.utils.math.latex2mathml.msup
- Undocumenteddocutils.utils.math.latex2mathml.mover
- Undocumenteddocutils.utils.math.latex2mathml.MathToken
- Token Element: contains textual data instead of children.docutils.utils.math.latex2mathml.mi
- Undocumenteddocutils.utils.math.latex2mathml.mn
- Undocumenteddocutils.utils.math.latex2mathml.mo
- Undocumenteddocutils.utils.math.latex2mathml.mtext
- Undocumenteddocutils.utils.math.latex2mathml.mfrac
- Undocumenteddocutils.utils.math.latex2mathml.mrow
- Group sub-expressions as a horizontal row.docutils.utils.math.latex2mathml.mspace
- Undocumenteddocutils.utils.math.latex2mathml.mtable
- Undocumenteddocutils.utils.math.math2html.BigBracket
- A big bracket generator.docutils.utils.math.math2html.Cloner
- An object used to clone other objects.docutils.utils.math.math2html.CommandLineParser
- A parser for runtime optionsdocutils.utils.math.math2html.Container
- A container for text and objects in a lyx filedocutils.utils.math.math2html.BlackBox
- A container that does not output anythingdocutils.utils.math.math2html.Formula
- A LaTeX formuladocutils.utils.math.math2html.FormulaBit
- A bit of a formuladocutils.utils.math.math2html.Bracket
- A {} bracket inside a formuladocutils.utils.math.math2html.SquareBracket
- A [] bracket inside a formuladocutils.utils.math.math2html.Comment
- A LaTeX comment: % to the end of the line.docutils.utils.math.math2html.FormulaCommand
- A LaTeX command inside a formuladocutils.utils.math.math2html.CommandBit
- A formula bit that includes a commanddocutils.utils.math.math2html.BeginCommand
- A \begin{}...\end command and what it entails (array, cases, aligned)docutils.utils.math.math2html.EmptyCommand
- An empty command (without parameters)docutils.utils.math.math2html.AlphaCommand
- A command without parameters whose result is alphabetical.docutils.utils.math.math2html.LimitCommand
- A command which accepts limits above and below, in display mode.docutils.utils.math.math2html.LimitPreviousCommand
- A command to limit the previous command.docutils.utils.math.math2html.FormulaEquation
- A simple numbered equation.docutils.utils.math.math2html.MultiRowFormula
- A formula with multiple rows.docutils.utils.math.math2html.EquationEnvironment
- A \begin{}...\end equation environment with rows and cells.docutils.utils.math.math2html.FormulaArray
- An array within a formuladocutils.utils.math.math2html.FormulaCases
- A cases statementdocutils.utils.math.math2html.FormulaMatrix
- A matrix (array with center alignment).docutils.utils.math.math2html.OneParamFunction
- A function of one parameterdocutils.utils.math.math2html.BracketCommand
- A command which defines a bracket.docutils.utils.math.math2html.CombiningFunction
- No class docstring; 2/2 methods documenteddocutils.utils.math.math2html.FontFunction
- A function of one parameter that changes the font.docutils.utils.math.math2html.OversetFunction
- A function that decorates some bit of text with an overset.docutils.utils.math.math2html.UndersetFunction
- A function that decorates some bit of text with an underset.docutils.utils.math.math2html.ParameterFunction
- A function with a variable number of parameters defined in a template.docutils.utils.math.math2html.HybridFunction
- A parameter function where the output is also defined using a template. The template can use a number of functions; each function has an associated tag. Example: [f0{$1},span class="fbox"] defines a function f0 which corresponds to a span of class fbox, yielding <span class="fbox">$1</span>...docutils.utils.math.math2html.SpacedCommand
- An empty command which should have math spacing in formulas.docutils.utils.math.math2html.SymbolFunction
- Find a function which is represented by a symbol (like _ or ^)docutils.utils.math.math2html.TextFunction
- A function where parameters are read as text.docutils.utils.math.math2html.FormulaCell
- An array cell inside a rowdocutils.utils.math.math2html.FormulaRow
- An array row inside an arraydocutils.utils.math.math2html.FormulaNumber
- A string of digits in a formuladocutils.utils.math.math2html.FormulaSymbol
- A symbol inside a formuladocutils.utils.math.math2html.RawText
- A bit of text inside a formuladocutils.utils.math.math2html.TaggedBit
- A tagged string in a formuladocutils.utils.math.math2html.WhiteSpace
- Some white space inside a formula.docutils.utils.math.math2html.WholeFormula
- Parse a whole formuladocutils.utils.math.math2html.StringContainer
- A container for a single stringdocutils.utils.math.math2html.Constant
- A constant stringdocutils.utils.math.math2html.FormulaConstant
- A constant string in a formuladocutils.utils.math.math2html.ContainerConfig
- Configuration class from elyxer.config filedocutils.utils.math.math2html.ContainerExtractor
- A class to extract certain containers.docutils.utils.math.math2html.ContainerOutput
- The generic HTML output for a container.docutils.utils.math.math2html.ContentsOutput
- Outputs the contents converted to HTMLdocutils.utils.math.math2html.FilteredOutput
- Returns the output in the contents, but filtered:docutils.utils.math.math2html.TaggedOutput
- Outputs an HTML tag surrounding the contents.docutils.utils.math.math2html.EmptyOutput
- No class docstring; 2/2 methods documenteddocutils.utils.math.math2html.FixedOutput
- Fixed outputdocutils.utils.math.math2html.StringOutput
- Returns a bare string as outputdocutils.utils.math.math2html.DocumentParameters
- Global parameters for the document.docutils.utils.math.math2html.EndingList
- A list of position endingsdocutils.utils.math.math2html.EscapeConfig
- Configuration class from elyxer.config filedocutils.utils.math.math2html.FormulaConfig
- Configuration class from elyxer.config filedocutils.utils.math.math2html.FormulaFactory
- Construct bits of formuladocutils.utils.math.math2html.FormulaProcessor
- A processor specifically for formulas.docutils.utils.math.math2html.Globable
- A bit of text which can be globbed (lumped together in bits). Methods current(), skipcurrent(), checkfor() and isout() have to be implemented by subclasses.docutils.utils.math.math2html.Position
- A position in a text to parse. Including those in Globable, functions to implement by subclasses are: skip(), identifier(), extract(), isout() and current().docutils.utils.math.math2html.TextPosition
- A parse position based on a raw text.docutils.utils.math.math2html.HybridSize
- The size associated with a hybrid function.docutils.utils.math.math2html.MathsProcessor
- A processor for a maths construction inside the FormulaProcessor.docutils.utils.math.math2html.BracketProcessor
- A processor for bracket commands.docutils.utils.math.math2html.LimitsProcessor
- A processor for limits inside an element.docutils.utils.math.math2html.Options
- A set of runtime optionsdocutils.utils.math.math2html.ParameterDefinition
- The definition of a parameter in a hybrid function.docutils.utils.math.math2html.Parser
- A generic parserdocutils.utils.math.math2html.BoundedDummy
- A bound parser that ignores everythingdocutils.utils.math.math2html.ExcludingParser
- A parser that excludes the final linedocutils.utils.math.math2html.BoundedParser
- A parser bound by a final linedocutils.utils.math.math2html.FormulaParser
- Parses a formuladocutils.utils.math.math2html.LoneCommand
- A parser for just one command linedocutils.utils.math.math2html.StringParser
- Parses just a stringdocutils.utils.math.math2html.TextParser
- A parser for a command and a bit of textdocutils.utils.math.math2html.PositionEnding
- An ending for a parsing positiondocutils.utils.math.math2html.Trace
- A tracing classdocutils.utils.Reporter
- Info/warning/error reporter and ``system_message`` element generator.docutils.utils.smartquotes.smartchars
- Smart quotes and dashesdocutils.writers.latex2e.Babel
- Language specifics for LaTeX.docutils.writers.xetex.Babel
- Language specifics for XeTeX.docutils.writers.latex2e.CharMaps
- LaTeX representations for active and Unicode characters.docutils.writers.latex2e.DocumentClass
- Details of a LaTeX document class.docutils.writers.latex2e.PreambleCmds
- Building blocks for the latex preamble.docutils.writers.latex2e.Table
- Manage a table while traversing.docutils.writers.manpage.Table
- No class docstring; 0/4 instance variable, 3/6 methods documenteddocutils.writers.odf_odt.ListLevel
- Undocumenteddocutils.writers.odf_odt.TableStyle
- UndocumentedException
docutils.ApplicationError
- Undocumenteddocutils.DataError
- Undocumenteddocutils.parsers.rst.states.InterpretedRoleNotImplementedError
- Undocumenteddocutils.parsers.rst.states.MarkupError
- Undocumenteddocutils.parsers.rst.states.UnknownInterpretedRoleError
- Undocumenteddocutils.parsers.rst.tableparser.TableMarkupError
- Raise if there is any problem with table markup.docutils.utils.ExtensionOptionError
- Undocumenteddocutils.utils.BadOptionDataError
- Undocumenteddocutils.utils.BadOptionError
- Undocumenteddocutils.utils.DuplicateOptionError
- Undocumenteddocutils.utils.NameValueError
- Undocumenteddocutils.parsers.rst.states.ParserError
- Undocumenteddocutils.transforms.TransformError
- Undocumenteddocutils.utils.code_analyzer.LexerError
- Undocumenteddocutils.utils.SystemMessage
- Undocumenteddocutils.utils.SystemMessagePropagation
- Undocumenteddocutils.writers.docutils_xml.RawXmlError
- Undocumenteddocutils.nodes.TreePruningException
- Base class for `NodeVisitor`-related tree pruning exceptions.docutils.nodes.NodeFound
- Raise to indicate that the target of a search has been found. This exception must be caught by the client; it is not caught by the traversal code.docutils.nodes.SkipChildren
- Do not visit any children of the current node. The current node's siblings and ``depart_...`` method are not affected.docutils.nodes.SkipDeparture
- Do not call the current node's ``depart_...`` method. The current node's children and siblings are not affected.docutils.nodes.SkipNode
- Do not visit the current node's children, and do not call the current node's ``depart_...`` method.docutils.nodes.SkipSiblings
- Do not visit any more siblings (to the right) of the current node. The current node's children and its ``depart_...`` method are not affected.docutils.nodes.StopTraversal
- Stop the traversal altogether. The current node's ``depart_...`` method is not affected. The parent nodes ``depart_...`` methods are also called as usual. No other nodes are visited. This is an alternative to NodeFound that does not cause exception handling to trickle up to the caller.docutils.parsers.rst.DirectiveError
- Store a message and a system message level.docutils.parsers.rst.states.MarkupMismatch
- Undocumenteddocutils.statemachine.StateCorrection
- Raise from within a transition method to switch to another state.docutils.statemachine.StateMachineError
- Undocumenteddocutils.statemachine.DuplicateStateError
- Undocumenteddocutils.statemachine.DuplicateTransitionError
- Undocumenteddocutils.statemachine.TransitionMethodNotFound
- Undocumenteddocutils.statemachine.TransitionPatternNotFound
- Undocumenteddocutils.statemachine.UnexpectedIndentationError
- Undocumenteddocutils.statemachine.UnknownStateError
- Undocumenteddocutils.statemachine.UnknownTransitionError
- Undocumenteddocutils.statemachine.TransitionCorrection
- Raise from within a transition method to switch to another transition.docutils.transforms.references.CircularSubstitutionDefinitionError
- Undocumenteddocutils.utils.roman.RomanError
- Undocumenteddocutils.utils.roman.InvalidRomanNumeralError
- Undocumenteddocutils.utils.roman.NotIntegerError
- Undocumenteddocutils.utils.roman.OutOfRangeError
- UndocumentedFutureWarning
docutils.frontend.ConfigDeprecationWarning
- Warning for deprecated configuration file features.namedtuple('VersionInfo', 'major minor micro releaselevel serial release')
docutils.VersionInfo
- Undocumentedoptparse.Option
docutils.frontend.Option
- Add validation and override support to `optparse.Option`.optparse.OptionParser
docutils.frontend.OptionParser
- Settings parser for command-line and library use.optparse.Values
docutils.frontend.Values
- Storage for option values.OSError
docutils.io.InputError
- Undocumenteddocutils.io.OutputError
- Undocumentedpygments.formatter.Formatter
recommonmark.parser.CommonMarkParser
docutils.parsers.recommonmark_wrapper.Parser
- MarkDown parser based on recommonmark.str
docutils.nodes.reprunicode
- Deprecated backwards compatibility stub. Use the standard `str` instead.docutils.nodes.Text
- Instances are terminal nodes (leaves) containing text only; no child nodes or attributes. Initialize by passing a string to the constructor.xml.etree.ElementTree.Element
docutils.writers.odf_odt._ElementInterfaceWrapper
- Undocumentedxml.sax.handler.ContentHandler
docutils.writers.docutils_xml.TestXml
- Undocumented