sphinx-contrib / whooshindex /

Filename Size Date modified Message
..
doc
sphinxcontrib
1.4 KB
47 B
1.8 KB
81 B
1.3 KB

Whoosh indexer extension for Sphinx

Author: Pauli Virtanen <pav@iki.fi>

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.

Building

Requirements

  • 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 setup.py install

Setuptools/PyPI

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 conf.py file. For example:

extensions = ['sphinxcontrib.whooshindex']

Usage

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

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.