自定义Sphinx以避免生成搜索框

Question

是否有一种简单的方法（即，没有创建一个全新的主题）来自定义Sphinx，以便它在没有搜索框的情况下生成HTML页面？

Answer 1

您可以通过自定义（或应该说禁用）搜索框模板来实现。

1. 在conf.py中，添加以下行：

   templates_path = ["templates"]
   

2. 在Sphinx项目目录中创建一个名为templates的文件夹。

3. 在该文件夹中，添加名为 searchbox.html 的空文件。这将覆盖默认模板文件（位于安装Sphinx的sphinx/themes/basic中）。

Answer 2

我发现阅读alabaster theme documentation的替代方法是明确列出conf.py文件中需要哪些（如果有任何侧边栏）。例如，在conf.py中包含此片段：

html_theme = 'alabaster'
html_sidebars = {
    '**': [
        'about.html',
        'navigation.html',
        'searchbox.html',
    ]
}

生成搜索框;从该列表中删除searchbox.html然后构建生成相同的页面但没有框。 （更多信息可在the Sphinx documentation for the build-configuration file找到。）