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 Root

Module nodes

Classes

Functions

dupname
ensure_str
fully_normalize_name
make_id
pseudo_quoteattr
serial_escape
unescape
whitespace_normalize_name
_add_node_class_names
_call_default_departure
_call_default_visit
_nop

Variables

node_class_names
_non_id_at_ends
_non_id_chars
_non_id_translate
_non_id_translate_digraphs

`docutils.nodes.Root`

class documentation

class Root: (source)

Known subclasses: docutils.nodes.document

View In Hierarchy

Undocumented

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