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 BadOptionDataError

Package utils

Modules

math
code_analyzer
error_reporting
punctuation_chars
roman
smartquotes
urischemes

Classes

BadOptionDataError
BadOptionError
DependencyList
DuplicateOptionError
ExtensionOptionError
NameValueError
Reporter
SystemMessage
SystemMessagePropagation

Functions

assemble_option_dict
clean_rcs_keywords
column_indices
column_width
decode_path
escape2null
extract_extension_options
extract_name_value
extract_options
find_combining_chars
find_file_in_dirs
get_source_line
get_stylesheet_list
get_stylesheet_reference
get_trim_footnote_ref_space
new_document
new_reporter
normalize_language_tag
relative_path
split_escaped_whitespace
strip_combining_chars
uniq
version_identifier

Variables

east_asian_widths
release_level_abbreviations

`docutils.utils.BadOptionDataError`

class documentation

class BadOptionDataError(ExtensionOptionError): (source)

View In Hierarchy

Undocumented

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