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

Module build_phase

Classes

BuildPhase

Package util

Modules

stemmer
build_phase
cfamily
console
display
docfields
docstrings
docutils
exceptions
fileutil
http_date
i18n
images
inspect
inventory
jsdump
logging
matching
math
nodes
osutil
parallel
png
requests
rst
tags
template
texescape
typing

Classes

DownloadFiles
FilenameUniqDict
Tee
UnicodeDecodeErrorHandler

Functions

docname_join
encode_uri
get_filetype
get_full_modname
get_matching_files
import_object
isurl
md5
parselinenos
sha1
split_full_qualified_name
split_index_msg
split_into
_xml_name_checker

Variables

logger
url_re
ws_re
_coding_re

`sphinx.util.build_phase`

module documentation

(source)

Build phase of Sphinx application.

Class BuildPhase Build phase of Sphinx application.

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