基于sphinx-bootstrap-theme在Python-Sphinx文档上启用侧栏

Question

我正在使用漂亮的sphinx-bootstrap-theme 0.3.4并尝试在Sphinx Python Documentation Generator 1.2版之上应用它。

当我通过make html构建文档时，我没有获得任何侧边栏，尽管在example中可以显示它。两者都没有，我能够在构建配置文件（conf.py）中找到任何启​​用侧栏的选项。 执行以下操作：

html_sidebars = {'sidebar': ['localtoc.html', 'sourcelink.html', 'searchbox.html']}

无济于事。

感谢您提供有关如何通过此类Sphinx主题启用侧边栏的任何提示。

Answer 1

刚想通了。这应该可以解决问题。

html_sidebars = {'**': ['localtoc.html', 'sourcelink.html', 'searchbox.html']}

将此作为参考

Sphinx theming guide html_sidebars

我正在尝试创建自定义侧边栏，因为我不喜欢附带的选项。使用bootstrap demo index.html我为自定义侧边栏创建了以下内容。只需将其命名为my_custom_sidebar.html，并将其放在/ source / _templates

中

<ul class="globaltoc"
>{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False,includehidden=theme_globaltoc_includehidden|tobool) }}</ul>

然后修改html_sidebars

html_sidebars = {'**': ['my_custom_sidebar.html', 'searchbox.html']}