构建性能和大小#

默认情况下,此主题在可折叠侧边栏中包含所有文档链接。但是,如果您有大量文档页面,这可能会显著减慢文档构建速度。这在具有大型 API 的项目文档中最为常见,这些项目使用 .. autosummary:: 指令生成 API 文档。

在这些情况下,为了提高构建性能,首先尝试修改侧边栏中的导航深度(参见 导航深度和折叠侧边栏)。如果这不起作用,请尝试下面部分中的修复。

从侧边栏中选择性地移除页面#

您可以使用名为 sphinx-remove-toctrees 的 Sphinx 插件来防止页面出现在导航栏中。如果您的文档在文件夹中生成了大量“存根页面”,这很有用,这在 API 文档中很常见。

这允许您添加如下配置:

remove_from_toctrees = ["folder_one/generated/*"]

并且 folder_one/generated/ 中的任何页面都不会出现在侧边栏中。

查看 sphinx-remove-toctrees 文档 了解如何安装和使用此扩展。