How to install WhooshDoc
- Download and install ActivePython
- Open Command Prompt
pypm install whooshdoc
WhooshDoc is an indexed, full-text search tool for Python docstrings. It uses Whoosh to do the indexing and searching, hence the name. It includes tools for collecting docstrings to index them and for searching the index.
For searching a prepared index, all you need is Whoosh. WhooshDoc uses epydoc to traverse packages and collect their docstrings in order to build a search index. However, epydoc is not required; you can add to a WhooshDoc index using the Whoosh API (see whooshdoc/util.py for the schema), without using epydoc.
You can install WhooshDoc, along with its dependencies, using with setuptools' easy_install:
$ easy_install WhooshDoc
or via the normal setup.py mechanism after downloading and unpacking the tarball:
$ cd WhooshDoc-1.0 $ python setup.py install
$ easy_install 'WhooshDoc[ui]'
The development source may be checked out via Subversion:
$ svn co https://svn.enthought.com/svn/enthought/WhooshDoc/trunk WhooshDoc
WhooshDoc comes with one script, wdoc. It has several sub-commands. Use "wdoc --help" and "wdoc <sub-command> --help" to see detailed help.
To index a package using epydoc to collect docstrings, use "wdoc index". For example:
$ wdoc index numpy
To use the console search utility, use "wdoc search". For example:
$ wdoc search --help # For an explanation of the query syntax. $ wdoc search bessel or airy not filter $ wdoc search '"phrase searches need weird quoting"'
# because shells also interpret quote characters.
To use the wxPython GUI, use "wdoc ui". For example:
$ wdoc ui $ wdoc ui bessel or airy not filter
To explicitly specify the WhooshDoc index directory, use the -i/--index option before any of these sub-commands. For example:
$ wdoc --index ~/Library/WhooshDoc search bessel
To remove certain docstrings (e.g., because you updated a package and want to reindex it), use "wdoc delgroups". For example:
# First, index a couple of scipy packages with the group name "scipy"
$ wdoc index --group scipy scipy.linalg scipy.optimize # Now delete them. $ wdoc delgroups scipy
WhooshDoc includes an IPython "magic" command, %whoosh, which performs a WhooshDoc query and presents the results in the console, like the "wdoc search" command. The %whoosh command integrates with IPython's help mechanisms to display the help for the individual items. To enable it, add the following to your ipy_user_conf.py file:
from whooshdoc.ipython import enable enable('/path/to/whooshdoc/index')
Now, you can search using %whoosh in IPython. For example:
In : %whoosh bessel or airy not filter
Please make a ticket on the Enthought Tool Suite (ETS) Trac instance:
Or send an email to the enthought-dev mailing list:
- Simple web app using wsgiref.