Sphinx支持简体中文搜索

问题:

sphinx-doc 默认不支持简体中文的自动检索,生成的html文档检索单个中文词时会显示无匹配结果,搜索整句时才会有匹配。

解决:

通过添加中文搜索支持插件来实现。

大致步骤:

  1. 安装结巴中文分词
pip install jieba

详细的安装方法参考这里

  1. 安装sphinx.search.zh_CN 插件
    复制 zh_CN.py 到 sphinx 的 search 目录下,如: C:\Python27\Lib\site-packages\sphinx\search
    打开 search 目录下的 init.py 找到:
from sphinx.search import en, ja
languages = {
    'en': en.SearchEnglish,
    'ja': ja.SearchJapanese,
}
修改成:
from sphinx.search import en, ja, zh_CN
languages = {
    'en': en.SearchEnglish,
    'ja': ja.SearchJapanese,
    'zh_CN': zh_CN.SearchChinese
}
  1. 在 sphinx 工程的 conf.py 中添加 language = 'zh_CN'或者html_search_language = `zh_CN`然后就可以 make html 了。

解决过程遇到的问题:

  1. python2

    按照上述顺序安装后,依然不能检索中文,考虑应该是插件没有起作用,进入安装目录:../site-pakeages/sphinx/search/后发现,zh_CN.py 没有生成对应的pyc文件,确实没起作用,随后运行ipython,查看import语句是否生效,也就是上面修改的:

from sphinx.search import en, ja, zh_CN

提示不能导入 name zh_CN。
不解,随后将sphinx卸载重新安装:

pip uninstall sphinx
pip install sphinx
pin install --upgrade sphinx

然后再次运行import,竟没有再报错,正常导入了!
最后在sphinx工程的文件夹运行:

make clean
make html

在生成语句中多了以下几句:

Building Trie..., from ***/anaconda/lib/python2.7/site-packages/jieba/dict.txt
loading model from cache /tmp/jieba.cache
loading model cost 0.798622131348 seconds.
Trie has been built succesfully.

用firefox打开生成的网页,可以检索中文了!

  1. python3
    另一台电脑装了python3的版本,在经历过以上各种折腾后依然不能正常使用。发现问题出在jieba这个包上面,当使用:
pip install jieba

总会有一些error出现,考虑可能是这个包不兼容python3,尝试到PyPI站点查找这个jieba包的信息,发现它的jieba_github站点,并在介绍里发现它有一个专门的python3版本jieba3k,安装方法在github里面也有介绍,简单可以:

pip install jieba3k

最终,python3 版本也搞定了!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容