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 references

Classes

TargetNotes

Package directives

Modules

admonitions
body
html
images
misc
parts
references
tables

Functions

choice
class_option
directive
encoding
flag
format_values
get_measure
length_or_percentage_or_unitless
length_or_unitless
nonnegative_int
parser_name
path
percentage
positive_int
positive_int_list
register_directive
single_char_or_unicode
single_char_or_whitespace_or_unicode
unchanged
unchanged_required
unicode_code
uri
value_or

Variables

length_units
unicode_pattern
_directive_registry
_directives

`docutils.parsers.rst.directives.references`

module documentation

(source)

Directives for references and targets.

Class TargetNotes Target footnote generation.

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