Skip to main content
Ctrl+K

PyData Theme

  • 用户指南
  • 贡献者指南
  • 示例
  • 变更日志
    • API
    • PyData Website
    • NumFocus
    • Donate to NumFocus
  • X
  • GitHub
  • PyPI
  • PyData
  • 用户指南
  • 贡献者指南
  • 示例
  • 变更日志
  • API
  • PyData Website
  • NumFocus
  • Donate to NumFocus
  • X
  • GitHub
  • PyPI
  • PyData

Section Navigation

快速入门

  • 安装
  • 主题结构与布局

导航与链接

  • 导航深度和折叠侧边栏
  • 页面目录
  • 页眉链接
  • 源代码按钮
  • Sphinx 索引

用户接口

  • 公告横幅
  • 版本切换器下拉菜单
  • 搜索栏 / 搜索按钮
  • 键盘快捷键
  • 国际化
  • 返回顶部按钮

内容与功能

  • 主题特定元素
  • 使用 ABlog 的博客
  • Sphinx Design 组件
  • 扩展主题

主题与样式

  • 品牌标识与徽标
  • 主题变量和 CSS
  • 字体和 FontAwesome
  • 浅色和深色主题

杂项

  • 可访问性
  • 分析与使用服务
  • 添加自定义 CSS 和 JS 资源
  • 构建性能和大小
  • 主题更改、弃用和警告
  • Read the Docs 功能
  • 用户指南
  • 导航深度和折叠侧边栏

导航深度和折叠侧边栏#

默认情况下,此主题允许在主要侧边栏导航中展开/折叠子部分(而无需实际导航到页面本身),并且这最多可扩展到 4 级深度:

../_images/demo-expandable-navigation.gif

控制默认显示的导航层级数量#

您可以控制页面加载时显示的导航层级数量。默认情况下,此层级为 1,仅显示顶级页面,并带有下拉框以显示其子页面。要使它们的子页面默认显示,您可以在 conf.py 中使用以下配置:

html_theme_options = {
  "show_nav_level": 2
}

这将使前两个导航层级默认显示(即顶级页面及其直接子页面)。

折叠整个 toctree 标题/部分#

如果您的 toctree 元素分配了标题(使用 :caption:),您可以折叠导航项,以便仅显示标题。单击标题将显示下面的项目。

要启用此行为,请将 show_nav_level 值设置为 0,如下所示:

html_theme_options = {
   "show_nav_level": 0
}

只有在为 toctree 项定义了标题时,才能将其折叠在标题下方!如果您的 toctree 未定义标题,则其下的所有页面都将显示(与默认主题行为相同)。有关更多详细信息,请参阅 toctree 文档。

备注

在某些 Sphinx 站点中,顶级 toctree 分组构成文档中的“部分”,其下的每个页面构成“章节”。

控制导航层级的数量#

此外,您还可以控制侧边栏中显示的导航层级数量(默认值为 4):

html_theme_options = {
  "navigation_depth": 2
}

移除侧边栏项的展开按钮#

可以通过将 collapse_navigation 配置选项设置为 True 来完全关闭可扩展导航:

html_theme_options = {
  "collapse_navigation": True
}

上一页

主题结构与布局

下一页

页面目录

On this page
  • 控制默认显示的导航层级数量
    • 折叠整个 toctree 标题/部分
  • 控制导航层级的数量
  • 移除侧边栏项的展开按钮
在 GitHub 上编辑
显示源代码

© Copyright 2019, PyData Community.

由 Sphinx 8.1.3创建。

Built with the PyData Sphinx Theme 0.16.1.