如何修改Sphinx文档生成器中的html标题分隔符

Question

默认情况下，似乎应该使用长破折号'——'作为页面标题和整个站点的分隔符，该分隔符是在config.py文件中设置的。

我们想把它改成一个'|'字符。

我可以在layout.html模板中添加一个块来修改标题，我只是不确定该写什么。我希望它是'page_title | html_title'在整个网站的标题标签。

Answer 1

em - dash (—)来自layout.html模板:

{%- if not embedded and docstitle %}
{%- set titlesuffix = " — "|safe + docstitle|e %}
{%- else %}
{%- set titlesuffix = "" %}
{%- endif %}

titlesuffix的值在模板的后面一点使用:

{%- block htmltitle %}
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
{%- endblock %}

定制:

1. 确保在conf.py中有templates_path = ['_templates']。

2. 在_templates目录下创建一个名为layout.html的文件

3. 在layout.html中添加以下内容:

   {% extends "!layout.html" %}
   {%- set customtitlesuffix = " | "|safe + docstitle|e %}
   {%- block htmltitle %}
   <title>{{ title|striptags|e }}{{ customtitlesuffix }}</title>
   {%- endblock %}
   

参见https://www.sphinx-doc.org/en/master/templating.html。