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

Module doctree

Classes

Reader

Package readers

Modules

doctree
pep
standalone

Classes

Reader
ReReader

Functions

get_reader_class

Variables

_reader_aliases

`docutils.readers.doctree`

module documentation

(source)

Reader for existing document trees.

Class Reader Adapt the Reader API for an existing document tree.

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