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

时间:2017-07-18 21:54:16

标签: python documentation python-sphinx

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

我有办法做以下其中一种吗?

  1. 定义标题文字但不将其渲染为页面上的标题?
  2. 以其他方式设置title页面元数据?

1 个答案:

答案 0 :(得分:4)

您可以自定义主题,覆盖包含<title>标记的部分。有关完整信息,请参阅Sphinx文档中的Templating。如果你有&#34;基本&#34;主题,您需要覆盖line 130 in layout.html

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

您可以使用Jinja2 templating language在主题中应用控制结构,以防您只想将此功能应用于一个页面,而不是其他页面。