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 tr

Classes

SearchTurkish

Package search

Modules

da
de
en
es
fi
fr
hu
it
ja
nl
no
pt
ro
ru
sv
tr
zh

Classes

IndexBuilder
SearchLanguage
WordCollector
WordStore
_JavaScriptIndex

Functions

parse_stop_word
_is_meta_keywords
_parse_index_entry

Variables

js_index
languages

`sphinx.search.tr`

module documentation

(source)

Turkish search language: includes the JS Turkish stemmer.

Class SearchTurkish Undocumented

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