2014-01-05 40 views
9

私はnice 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']} 

は役に立ちません。

このようなSphinxテーマからサイドバーを有効にする方法についてのヒントはありがとうございます。

答えて

13

ちょっと分かりました。これはトリックを行う必要があります。

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

私は含まオプションを好きではないので、カスタムのサイドバーを作成して実験しています参照

Sphinx theming guide html_sidebars

としてこれを使用します。ブートストラップのデモindex.htmlを使用して、カスタムサイドバーに以下を作成しました。ただ、それをmy_custom_sidebar.htmlのようなものに名前を付け、それは `theme_globaltoc_depth`のエラーを投げているhtml_sidebars

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

を編集すると/ソース/ _templatesに

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

をそれを置きます。 その場合は、取り外してください。 –

関連する問題