Sphinx 文档：定义但隐藏标题/标题文本

Question

我正在使用 Sphinx 来记录 Python 包。标题页/启动页的顶部包含带有项目徽标和文本的图形。这给出了我想要的视觉外观，但因为我没有定义顶级标题，所以页面

title

元数据（在浏览器选项卡中呈现）设置为

<no title> — my project name

。

我有办法执行以下操作之一吗？

1. 定义标题文本但不将其呈现为页面上的标题？
2. 以其他方式设置

   title

   页面元数据？

Answer 1

您可以自定义主题，覆盖包含

<title>

标签的部分。有关完整信息，请参阅 Sphinx 文档中的模板化。如果您有“基本”主题，则需要覆盖layout.html中的第130行

    <title>{{ title|striptags|e }}{{ titlesuffix }}</title>

您可以使用 Jinja2 模板语言在主题中应用控制结构，以防您只想将此功能应用于一页而不是其他页面。

Answer 2

在此问题之后，geographika提出了一种解决方法，我将其用于我自己的文档：

.. raw:: html

   <div style="height: 0; visibility: hidden;">

My Title
========

.. raw:: html

   </div>

我添加了

height: 0;

以避免标题占用文档中的垂直空间。