sphinx.search

package documentation

(source)

Create a full-text search index for offline search.

Module	`da`	Danish search language: includes the JS Danish stemmer.
Module	`de`	German search language: includes the JS German stemmer.
Module	`en`	English search language: includes the JS porter stemmer.
Module	`es`	Spanish search language: includes the JS Spanish stemmer.
Module	`fi`	Finnish search language: includes the JS Finnish stemmer.
Module	`fr`	French search language: includes the JS French stemmer.
Module	`hu`	Hungarian search language: includes the JS Hungarian stemmer.
Module	`it`	Italian search language: includes the JS Italian stemmer.
Module	`ja`	Japanese search language: includes routine to split words.
Module	`nl`	Dutch search language: includes the JS porter stemmer.
Module	`no`	Norwegian search language: includes the JS Norwegian stemmer.
Module	`pt`	Portuguese search language: includes the JS Portuguese stemmer.
Module	`ro`	Romanian search language: includes the JS Romanian stemmer.
Module	`ru`	Russian search language: includes the JS Russian stemmer.
Module	`sv`	Swedish search language: includes the JS Swedish stemmer.
Module	`tr`	Turkish search language: includes the JS Turkish stemmer.
Module	`zh`	Chinese search language: includes routine to split words.

From __init__.py:

Class	`IndexBuilder`	Helper class that creates a search index based on the doctrees passed to the `feed` method.
Class	`SearchLanguage`	This class is the base class for search natural language preprocessors. If you want to add support for a new language, you should override the methods of this class.
Class	`WordCollector`	A special visitor that collects words for the `IndexBuilder`.
Class	`WordStore`	Undocumented
Function	`parse_stop_word`	Parse snowball style word list like this:
Variable	`js_index`	Undocumented
Variable	`languages`	Undocumented
Class	`_JavaScriptIndex`	The search index as JavaScript file that calls a function on the documentation search object to register the index.
Function	`_is_meta_keywords`	Undocumented
Function	`_parse_index_entry`	Undocumented

Parse snowball style word list like this: * http://snowball.tartarus.org/algorithms/finnish/stop.txt

languages: dict[str, str|type[SearchLanguage]] = (source) ¶

Undocumented

Undocumented

def _is_meta_keywords(node, lang): (source) ¶

Undocumented

def _parse_index_entry(entry_type, value, target_id, main): (source) ¶

Undocumented