diff options
| author | Georg Brandl <georg@python.org> | 2010-08-21 19:15:14 +0200 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-08-21 19:15:14 +0200 |
| commit | 33c6ad4dc4b356372e79eedbf8abbfc022f921be (patch) | |
| tree | 7d0bb86258a798f0a19a26c1c4a19c4c08083349 /doc/web/searchadapters.rst | |
| parent | a3204e1529750cb492e9f93650daff9947581a7a (diff) | |
| download | sphinx-33c6ad4dc4b356372e79eedbf8abbfc022f921be.tar.gz | |
Adapt style for websupport docs.
Diffstat (limited to 'doc/web/searchadapters.rst')
| -rw-r--r-- | doc/web/searchadapters.rst | 43 |
1 files changed, 21 insertions, 22 deletions
diff --git a/doc/web/searchadapters.rst b/doc/web/searchadapters.rst index a84aa8da..7d8634f7 100644 --- a/doc/web/searchadapters.rst +++ b/doc/web/searchadapters.rst @@ -6,41 +6,40 @@ Search Adapters =============== To create a custom search adapter you will need to subclass the -:class:`~BaseSearch` class. Then create an instance of the new class -and pass that as the `search` keyword argument when you create the -:class:`~sphinx.websupport.WebSupport` object:: +:class:`BaseSearch` class. Then create an instance of the new class and pass +that as the `search` keyword argument when you create the :class:`~.WebSupport` +object:: - support = Websupport(srcdir=srcdir, - builddir=builddir, - search=MySearch()) + support = WebSupport(srcdir=srcdir, + builddir=builddir, + search=MySearch()) -For more information about creating a custom search adapter, please see -the documentation of the :class:`BaseSearch` class below. +For more information about creating a custom search adapter, please see the +documentation of the :class:`BaseSearch` class below. .. class:: BaseSearch - Defines an interface for search adapters. + Defines an interface for search adapters. + BaseSearch Methods ~~~~~~~~~~~~~~~~~~ - The following methods are defined in the BaseSearch class. Some methods - do not need to be overridden, but some ( - :meth:`~sphinx.websupport.search.BaseSearch.add_document` and - :meth:`~sphinx.websupport.search.BaseSearch.handle_query`) must be - overridden in your subclass. For a working example, look at the - built-in adapter for whoosh. + The following methods are defined in the BaseSearch class. Some methods do + not need to be overridden, but some (:meth:`~BaseSearch.add_document` and + :meth:`~BaseSearch.handle_query`) must be overridden in your subclass. For a + working example, look at the built-in adapter for whoosh. -.. automethod:: sphinx.websupport.search.BaseSearch.init_indexing +.. automethod:: BaseSearch.init_indexing -.. automethod:: sphinx.websupport.search.BaseSearch.finish_indexing +.. automethod:: BaseSearch.finish_indexing -.. automethod:: sphinx.websupport.search.BaseSearch.feed +.. automethod:: BaseSearch.feed -.. automethod:: sphinx.websupport.search.BaseSearch.add_document +.. automethod:: BaseSearch.add_document -.. automethod:: sphinx.websupport.search.BaseSearch.query +.. automethod:: BaseSearch.query -.. automethod:: sphinx.websupport.search.BaseSearch.handle_query +.. automethod:: BaseSearch.handle_query -.. automethod:: sphinx.websupport.search.BaseSearch.extract_context +.. automethod:: BaseSearch.extract_context |