2014-01-05 21 views
9

我使用的是良好的sphinx-bootstrap-theme 0.3.4,并试图将其应用于Sphinx Python Documentation Generator 1.2版本之上。在基于sphinx-bootstrap-theme的Python-Sphinx文档中启用侧边栏

当我通过make html构建文档时,虽然在此example中显示可能,但我没有得到任何侧边栏。我也没有找到任何选项来在构建配置文件(conf.py)中启用侧边栏。 执行以下操作:

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

没有帮助。

感谢您提供关于如何从这样的狮身人面像主题启用边栏的提示。

回答

13

只是想通了。这应该做的伎俩。

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

以此为参考

Sphinx theming guide html_sidebars

我与创建自定义侧边栏,因为我不喜欢的选项包括试验。使用引导演示index.html我为自定义边栏创建了以下内容。仅举它像my_custom_sidebar.html,并把它放在/源/ _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']} 
+0

它抛出错误'theme_globaltoc_depth'。为了以防万一,请将其移除。 –