WhooshDoc 1.0

先决条件

要搜索已准备的索引，您只需要Whoosh。WhooshDoc使用epydoc遍历包并收集它们的文档字符串以构建搜索索引。然而，epydoc不是必需的；您可以使用Whoosh API（见whooshdoc/util.py中的模式）向WhooshDoc索引中添加内容，而无需使用epydoc。

此软件包使用setuptools进行安装和定位默认WhooshDoc索引。WhooshDoc使用argparse进行命令行参数。

安装

您可以使用setuptools的easy_install安装WhooshDoc及其依赖项

$ easy_install WhooshDoc

或通过下载和展开tarball后的正常setup.py机制

$ cd WhooshDoc-1.0
$ python setup.py install

要使用wxPython搜索GUI，您必须安装Enthought的Traits和TraitsBackendWX软件包。为此，请使用以下easy_install命令

$ easy_install 'WhooshDoc[ui]'

可以通过Subversion检查开发源代码

$ svn co https://svn.enthought.com/svn/enthought/WhooshDoc/trunk WhooshDoc

wdoc

WhooshDoc包含一个脚本，wdoc。它有几个子命令。使用“wdoc –help”和“wdoc <sub-command> –help”查看详细帮助。

要使用epydoc收集文档字符串来索引一个包，请使用“wdoc index”。例如

$ wdoc index numpy

要使用控制台搜索实用程序，请使用“wdoc search”。例如

$ 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.

要使用wxPython GUI，请使用“wdoc ui”。例如

$ wdoc ui
$ wdoc ui bessel or airy not filter

要显式指定WhooshDoc索引目录，在使用任何子命令之前使用-i/–index选项。例如

$ wdoc --index ~/Library/WhooshDoc search bessel

要删除某些docstrings（例如，因为您更新了一个包并希望重新索引它），请使用“wdoc delgroups”。例如

# 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

IPython

WhooshDoc包含一个IPython“魔术”命令%，whoosh，它执行WhooshDoc查询并在控制台中显示结果，就像“wdoc search”命令一样。%whoosh命令与IPython的帮助机制集成，以显示单个项的帮助。要启用它，将以下内容添加到您的ipy_user_conf.py文件中

from whooshdoc.ipython import enable
enable('/path/to/whooshdoc/index')

现在，您可以在IPython中使用%whoosh进行搜索。例如

In [10]: %whoosh bessel or airy not filter

错误

请在Enthought Tool Suite (ETS) Trac实例上创建一个票证

https://svn.enthought.com/enthought

或将电子邮件发送到enthought-dev邮件列表

https://mail.enthought.com/mailman/listinfo/enthought-dev

待办事项

• 使用wsgiref的简单Web应用。