页面目录

默认显示更多级别的页面目录

通常，页面右侧目录仅显示页面的二级标题，更深级别的标题仅在它们属于活动部分（在屏幕上滚动时）时才会显示。

您可以使用以下配置默认显示更深级别的标题，指示应显示多少个级别

html_theme_options = {
  "show_toc_level": 2
}

现在将显示指定级别及以下的所有标题，无论页面上显示的内容如何。

删除页面目录

要删除页面目录，请在页面顶部的 文件范围元数据 中添加 :html_theme.sidebar_secondary.remove:。这将仅从该页面中删除页面目录。

每个页面的次级侧边栏内容

html_theme_options['secondary_sidebar_items'] 接受 list，其中包含要在每个页面上呈现的次级侧边栏模板

html_theme_options = {
  "secondary_sidebar_items": ["page-toc", "sourcelink"]
}

或者接受 dict，其中将页面名称映射到 list，其中包含次级侧边栏模板

html_theme_options = {
  "secondary_sidebar_items": {
    "**": ["page-toc", "sourcelink"],
    "index": ["page-toc"],
  }
}

如果指定了 dict，则键可以包含通配符样式的模式；与模式匹配的页面名称将包含指定的侧边栏模板。这与 Sphinx 自身的一部分 html_sidebars 选项的行为非常相似，只是它作用于次级侧边栏而不是主要侧边栏。有关更多信息，请参阅 Sphinx 文档。