Sphinx Skeleton
1

Table of Contents

  • 1. Sphinx
  • 2. sphinx/themes
  • 3. sphinx.ext
  • 4. sphinx.builders
  • 5. sphinx.domains
  • 6. sphinx.util
  • 7. sphinx.websupport
  • 8. misc modules
Sphinx Skeleton
  • Docs »
  • sphinx.search
  • View page source

sphinx.search¶

Create a full-text search index for offline search.

copyright:Copyright 2007-2016 by the Sphinx team, see AUTHORS.
license:BSD, see LICENSE for details.

Functions¶

iteritems(d, **kw) Return an iterator over the (key, value) pairs of a dictionary.
itervalues(d, **kw) Return an iterator over the values of a dictionary.
parse_stop_word(source) parse snowball style word list like this:
rpartition(s, t) Similar to str.rpartition from 2.5, but doesn’t return the separator.

Classes¶

IndexBuilder(env, lang, options, scoring) Helper class that creates a searchindex based on the doctrees passed to the feed method.
NodeVisitor(document) “Visitor” pattern [GoF95] abstract superclass implementation for
SearchEnglish(options)
SearchLanguage(options) This class is the base class for search natural language preprocessors.
Text(data[, rawsource]) Instances are terminal nodes (leaves) containing text only; no child nodes or attributes.
WordCollector(document, lang) A special visitor that collects words for the IndexBuilder.
comment([rawsource, text])
raw([rawsource, text]) Raw data that is to be passed untouched to the Writer.
text_type alias of unicode
title([rawsource, text])

Exceptions¶

SkipNode Do not visit the current node’s children, and do not call the current node’s depart_... method.

© Copyright 2016.

Built with Sphinx using a theme provided by Read the Docs.