构建性能和大小#

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

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

有选择地从侧边栏中删除页面#

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

这使您可以添加如下配置

remove_from_toctrees = ["folder_one/generated/*"]

并且位于 folder_one/generated/ 中的任何页面都不会显示在侧边栏中。

查看 sphinx-remove-toctrees 文档 以获取有关如何安装和使用此扩展的信息。