跳转到主要内容

Sphinx的即时搜索

项目描述

此扩展修改了Sphinx文档中的搜索框,在您键入时显示即时结果。它特别适合搜索API。

要开始,请运行 $ pip install sphinxcontrib-lunrsearch,然后将在您的Sphinx conf.py 文件中的扩展列表中添加 'sphinxcontrib.lunrsearch'

选项

在conf.py中可以设置以下选项

  • lunrsearch_highlight: bool

    是否在导航到结果后突出显示搜索词。默认为 False

示例

http://i.giphy.com/3o85xmqkbt14LuRcZO.gif

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源分布

sphinxcontrib-lunrsearch-0.4.tar.gz (9.4 kB 查看哈希值)

上传时间 源代码

构建分发版

sphinxcontrib_lunrsearch-0.4-py2.py3-none-any.whl (8.6 kB 查看哈希值)

上传时间 Python 2 Python 3

支持