页面目录

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

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

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

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 文档。