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

Dan*_*age 6 python html-title python-sphinx

我正在使用 Sphinx 来记录 Python 包。标题页/启动页的顶部包含带有项目徽标和文本的图形。这给出了我想要的视觉外观,但因为我没有定义顶级标题,所以页面title元数据(在浏览器选项卡中呈现)设置为<no title> \xe2\x80\x94 my project name.

\n\n

有没有办法我可以执行以下操作之一?

\n\n
    \n
  1. 定义标题文本但不将其呈现为页面上的标题?
  2. \n
  3. title以其他方式设置页面元数据?
  4. \n
\n

Ste*_*rcy 5

您可以自定义主题,覆盖包含标签的部分<title>。有关完整信息,请参阅Sphinx 文档中的模板。如果您有“基本”主题,则需要覆盖layout.html中的第130行

    <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
Run Code Online (Sandbox Code Playgroud)

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