sphinx.search

package documentation

Create a full-text search index for offline search.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Module da sphinx.search.da ~~~~~~~~~~~~~~~~
Module de sphinx.search.de ~~~~~~~~~~~~~~~~
Module en sphinx.search.en ~~~~~~~~~~~~~~~~
Module es sphinx.search.es ~~~~~~~~~~~~~~~~
Module fi sphinx.search.fi ~~~~~~~~~~~~~~~~
Module fr sphinx.search.fr ~~~~~~~~~~~~~~~~
Module hu sphinx.search.hu ~~~~~~~~~~~~~~~~
Module it sphinx.search.it ~~~~~~~~~~~~~~~~
Module ja sphinx.search.ja ~~~~~~~~~~~~~~~~
Module jssplitter sphinx.search.jssplitter ~~~~~~~~~~~~~~~~~~~~~~~~
Module nl sphinx.search.nl ~~~~~~~~~~~~~~~~
Module no sphinx.search.no ~~~~~~~~~~~~~~~~
Module pt sphinx.search.pt ~~~~~~~~~~~~~~~~
Module ro sphinx.search.ro ~~~~~~~~~~~~~~~~
Module ru sphinx.search.ru ~~~~~~~~~~~~~~~~
Module sv sphinx.search.sv ~~~~~~~~~~~~~~~~
Module tr sphinx.search.tr ~~~~~~~~~~~~~~~~
Module zh sphinx.search.zh ~~~~~~~~~~~~~~~~

From __init__.py:

Variable js​_index Undocumented
Variable languages Undocumented
Class _​Java​Script​Index The search index as JavaScript file that calls a function on the documentation search object to register the index.
Class ​Index​Builder Helper class that creates a search index based on the doctrees passed to the feed method.
Class ​Search​Language 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 ​Word​Collector A special visitor that collects words for the IndexBuilder.
Function parse​_stop​_word Parse snowball style word list like this:
def parse_stop_word(source):

Parse snowball style word list like this:

Parameters
source:strUndocumented
Returns
Set[str]Undocumented
languages: Dict[str, Any] =

Undocumented

js_index =

Undocumented