Home > sphinx-6.1.3

sphinx 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 ValidationError

Module quickstart

Classes

QuickstartRenderer
ValidationError

Functions

allow_empty
ask_user
boolean
choice
do_prompt
generate
get_parser
is_path
is_path_or_empty
main
nonempty
ok
suffix
term_input
valid_dir

Variables

COLOR_QUESTION
DEFAULTS
EXTENSIONS
PROMPT_PREFIX
READLINE_AVAILABLE
USE_LIBEDIT

`sphinx.cmd.quickstart.ValidationError`

exception documentation

class ValidationError(Exception): (source)

View In Hierarchy

Raised for validation errors.

API Documentation for sphinx, generated by pydoctor 22.9.1 at 2023-01-11 01:04:09.