reStructuredText Sphinxdoc 相关

无聊达612

已于 2025-03-15 20:39:41 修改

阅读量510

点赞数

文章标签： sphinx

于 2022-06-01 09:31:10 首次发布

本文链接：https://blog.csdn.net/qq_34234087/article/details/125077709

版权

本文介绍了如何在Sphinx文档中启用中文搜索，通过jieba分词实现更准确的中文匹配。同时，展示了如何调整ReadtheDocs主题，包括设置宽屏布局和添加底部版权信息。此外，还提供了搜索页面的中文优化方案。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.中文搜索

python sphinx doc 已经自带中文搜索

在site-packages\sphinx\search\zh.py下

如果安装了jieba分词，就能正常以中文的方式进行分词，否则就以英文的方式进行

如果要安装jieba分词，用以下命令安装

pip install jieba

安装完jieba分词，就能正常以中文的方式进行分词了

2. readthedocs主题相关

1.将readthedocs主题设置为宽屏

默认的readthedocs页面宽度很窄

可以将主题设置为宽屏

在_static目录下新建style.css，在_templates目录下新建layout.html

style.css内的代码如下

.wy-nav-content {
    max-width: none;
}

layout.html内的代码如下

{% extends "!layout.html" %}
{% block extrahead %}
    <link href="{{ pathto("_static/style.css", True) }}" rel="stylesheet" type="text/css">
{% endblock %}

2.在页面底部增加ICP备案号和网站版权信息等

在_templates目录下新建footer.html

{% extends "!footer.html" %}
{% block extrafooter %}
<a href="https://beian.miit.gov.cn/" target="_blank">粤ICP备xxxxxxx号</a>
&nbsp&nbsp&nbsp&nbsp
<a href="http://www.xxx.com/" target="_blank">&#169; 版权所有 2013 - 2025 xxxxxxxxxx</a>
{% endblock %}