Search Adapters
***************

To create a custom search adapter you will need to subclass the
"BaseSearch" class.  Then create an instance of the new class and pass
that as the *search* keyword argument when you create the "WebSupport"
object:

   support = WebSupport(srcdir=srcdir,
                        builddir=builddir,
                        search=MySearch())

For more information about creating a custom search adapter, please
see the documentation of the "BaseSearch" class below.

class sphinxcontrib.websupport.search.BaseSearch

   Defines an interface for search adapters.

Changed in version 1.6: BaseSearch class is moved to
sphinxcontrib.websupport.search from sphinx.websupport.search.


Methods
=======

The following methods are defined in the BaseSearch class. Some
methods do not need to be overridden, but some ("add_document()" and
"handle_query()") must be overridden in your subclass. For a working
example, look at the built-in adapter for whoosh.
