Home > docutils-0.19

docutils API Documentation Modules Classes Names

search in docstrings

Search bar offers the following options:

Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
Wildcards. The below example searches for documents with words beginning with “foo”: foo*
Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.
Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Class MarkupError

Module states

Classes

Body
BulletList
Definition
DefinitionList
EnumeratedList
Explicit
ExtensionOptions
FieldList
Inliner
InterpretedRoleNotImplementedError
Line
LineBlock
MarkupError
MarkupMismatch
NestedStateMachine
OptionList
ParserError
QuotedLiteralBlock
RFC2822Body
RFC2822List
RSTState
RSTStateMachine
SpecializedBody
SpecializedText
Struct
SubstitutionDef
Text
UnknownInterpretedRoleError

Functions

build_regexp
_loweralpha_to_int
_lowerroman_to_int
_upperalpha_to_int

Variables

state_classes

`docutils.parsers.rst.states.MarkupError`

class documentation

class MarkupError(DataError): (source)

View In Hierarchy

Undocumented

API Documentation for docutils, generated by pydoctor 22.5.1 at 2022-07-13 18:33:46.