Sphinx ドキュメンとのサイドバーに目次を表示する方法

Sphinx で使用するテンプレートによっては、サイドバーに目次が表示されません。
しかし、カスタムテンプレートを作成してすることで目次を表示させることができます。

目次表示用のテンプレートを作成する

目次表示用に使用するテンプレートを作成して「ドキュメントルート/source/_tmeplates」に置いておき、以下の内容で保存します。

<div id="toc" class="sidebarRow">



<h3><a href="{{ pathto(master_doc) }}">目次</a></h3>

{%- if sphinx_version[:3] >= '1.2' %}

{{ toctree (maxdepth=3, collapse=False, includehidden=True) }}

{% else %}

{{ toctree(maxdepth=3, collapse=False) }}

{% endif %}

</div>

conf.pyを編集する

「conf.py」の「html_sidebars」の項目を以下のように記述します。

html_sidebars = {

'**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'],

}

• relations.html
• 「Previous topic」「Next topic」を表示する
• sourcelink.html
• 「Show Source」のリンクを表示する
• searchbox.html
• 検索ボックスを表示する