sphinx-contrib / whooshindex /

Filename Size Date modified Message
1.4 KB
47 B
1.7 KB
81 B
1.3 KB
.. -*- restructuredtext -*-

Whoosh indexer extension for Sphinx

:author: Pauli Virtanen <>

.. module:: sphinxcontrib.whooshindex
   :synopsis: Index Sphinx documents with the Whoosh indexing engine

This extension adds an additional builder, the :class:`WhooshBuilder`.
It indexes all documents using the Whoosh_ pure-Python indexing
engine, and places the resulting index in the output directory.

The name of the builder is ``whoosh``.

.. _Whoosh:



* Whoosh_ (0.3 or later).
* reportlab_ (for LaTeX/PDF output)
* PIL_ (for any image format other than SVG or PDF)

From source (tar.gz or checkout)

Unpack the archive, enter the sphinxcontrib-aafig-x.y directory and run::

    python install


Alternatively it can be installed from PyPI_, either manually downloading the
files and installing as described above or using:

easy_install -U sphinxcontrib-whoosh

Enabling the extension in Sphinx_

Just add ``sphinxcontrib.whooshindex`` to the list of extensions in the
```` file. For example::

    extensions = ['sphinxcontrib.whooshindex']


Give a builder name ``whoosh`` to ``sphinxbuild``. The Whoosh index will
be placed to the output directory.

.. Links:
.. _aafigure:
.. _reStructuredText:
.. _Sphinx:
.. _reportlab:
.. _PIL:
.. _PyPI: