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

Question

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

Answer 1

您可以通过自定义(或应该说禁用)搜索框模板来完成此操作.

1. 在conf.py中,添加以下行:

   templates_path = ["templates"]
   

2. 创建templates在Sphinx项目目录中调用的文件夹.

3. 在该文件夹中,添加一个名为searchbox.html的空文件.这将覆盖默认模板文件(位于sphinx/themes/basic安装Sphinx的位置).

Answer 2

我发现阅读雪花石膏主题文档的另一种方法是明确列出文件中需要哪些(如果有任何侧边栏)conf.py.例如,将此片段包含在conf.py:

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

生成搜索框; searchbox.html从该列表中删除然后构建生成相同的页面但没有框.(有关构建配置文件的更多信息,请参阅Sphinx文档.)