Home > pygments-2.14.0

pygments 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

Exception OptionError

Module util

Classes

Future
UnclosingTextIOWrapper
ClassNotFound
OptionError

Functions

docstring_headline
doctype_matches
duplicates_removed
format_lines
get_bool_opt
get_choice_opt
get_int_opt
get_list_opt
guess_decode
guess_decode_from_terminal
html_doctype_matches
looks_like_xml
make_analysator
shebang_matches
surrogatepair
terminal_encoding

Variables

doctype_lookup_re
split_path_re
tag_re
xml_decl_re
_looks_like_xml_cache

`pygments.util.OptionError`

exception documentation

class OptionError(Exception): (source)

View In Hierarchy

Undocumented

API Documentation for pygments, generated by pydoctor 22.9.1 at 2023-01-02 00:57:10.