页眉和导航栏#

默认情况下,此主题不包含任何页眉内容,它仅有一个侧边栏和一个主内容窗口。但是,您可以使用 PyData Sphinx Theme 的页眉配置 来添加您自己的页眉组件。如果设置了任何这些配置,则页眉将显示在页面顶部。

向页眉导航栏添加组件#

您可以在 html_theme_options 中使用以下三个配置选项:

navbar_start: 在页眉的开头添加组件。在所有屏幕尺寸上可见。使用此选项添加您希望始终显示的徽标。

navbar_center: 在页眉的中心添加组件,如果未定义 navbar_start,则添加到左侧。在移动设备上移至侧边栏。使用此选项添加指向外部页面的额外导航内容。

navbar_end: 在页眉的末尾添加组件。在移动设备上移至侧边栏。使用此选项添加额外的社交链接或按钮。

示例#

例如,您可以像这样在页眉中添加按钮:

创建 HTML 模板。在 _templates/mybutton.html 中,输入以下文本:

<button>My test button</button>

确保 _templates 在你的模板路径中。

将以下内容添加到 conf.py

html_theme_options = {
  "navbar_end": ["mybutton.html"]
}

现在,你的页眉应该可见,并且 mybutton.html 的内容应该显示在右上角。

覆盖整个页眉

或者,你可以通过在 _templates/sections/header.html 定义文件来覆盖整个页眉。

为页眉添加样式#

请注意,默认情况下页眉几乎没有应用任何样式。因此,你应该为主题添加自定义样式,以实现你想要的外观和感觉。