Skip to content

Commit

Permalink
fix chinese words search
Browse files Browse the repository at this point in the history
  • Loading branch information
HaoXuan40404 committed Nov 21, 2024
1 parent 519fc27 commit 6395057
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ _build
.DS_Store
.vscode/
*.bak
3.x/zh_CN/venv/
35 changes: 34 additions & 1 deletion 3.x/zh_CN/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@

import sys
import os
import jieba

#sys.path.insert(0, os.path.abspath('..'))
import sphinx_rtd_theme
from recommonmark.transform import AutoStructify

from sphinx.search import SearchEnglish

DOC_SOURCES_DIR = os.path.dirname(os.path.abspath(__file__))
PROJECT_ROOT_DIR = os.path.dirname(os.path.dirname(DOC_SOURCES_DIR))
Expand Down Expand Up @@ -64,6 +65,15 @@
'myst_parser'
]

myst_enable_extensions = [
"linkify", # 自动转换 URL 为链接
# "replacements", # 支持文本替换
# "smartquotes", # 美化引号
# "strikethrough", # 支持删除线
# "substitution", # 支持替换变量
# "attrs_block", # 支持 Markdown 块级属性
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['../_templates']

Expand Down Expand Up @@ -234,6 +244,22 @@
#html_search_language = 'en'
html_search_language = 'zh'

additional_keywords = [
'区块链',
'智能合约',
'共识算法',
'分布式账本',
'密码学',
'交易',
'非对称加密',
'联盟链'
]

html_search_options = {
'search_language': 'zh', # 指定中文
'search_mode': 'full_text', # 全文搜索
}

# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
#html_search_options = {'type': 'default'}
Expand Down Expand Up @@ -347,6 +373,12 @@
# Markdown support


class SearchChinese(SearchEnglish):
def split(self, input):
# 使用 jieba 对输入文本分词
return list(jieba.cut(input))


github_doc_root = 'https://github.com/rtfd/recommonmark/tree/master/doc/'
def setup(app):
app.add_config_value('recommonmark_config', {
Expand All @@ -360,6 +392,7 @@ def setup(app):
app.add_stylesheet('css/custom.css')
app.add_javascript('js/readthedocs-analytics.js')
app.connect('build-finished', replace_source)
app.add_config_value('additional_keywords', additional_keywords, 'env')

def replace_source(app, exception):
if exception is None:
Expand Down
4 changes: 3 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,6 @@ git-lfs
Jinja2<3.1
myst-parser == 0.13.0
pyyaml

jieba
linkify-it-py
# markdown-it-py

0 comments on commit 6395057

Please sign in to comment.