Sphinx文档生成器中如何修改HTML标题分隔符
修改Sphinx页面标题分隔符为“|”
要把Sphinx默认的页面标题与全站html_title之间的“--”分隔符改成“|”,直接修改自定义模板里的标题生成逻辑即可,步骤如下:
- 先在你的Sphinx项目根目录下创建
_templates文件夹(如果还没有的话),然后从Sphinx默认主题的模板目录中复制layout.html到这个文件夹。默认模板路径通常是Sphinx安装目录下的sphinx/themes/basic/layout.html。 - 打开复制后的
layout.html,找到生成<title>标签的代码块,默认写法类似:<title>{% block title %}{{ docstitle|e }}{% if docstitle and pagename %} -- {{ title|e }}{% endif %}{% endblock %}</title> - 将这段代码替换为:
这段代码的逻辑是:如果当前是具体页面(非首页),就先显示页面标题,再加上“|”和你在<title>{% block title %}{% if pagename %}{{ title|e }} | {% endif %}{{ html_title|e }}{% endblock %}</title>config.py中设置的html_title;如果是首页,则只显示html_title。 - 保存模板后,重新执行Sphinx的构建命令(比如
make html),所有页面的标题就会变成「页面标题 | 全站标题」的格式。
内容的提问来源于stack exchange,提问作者Chris
相关产品推荐
相关产品推荐

