サイドバーしたい(html_sidebars)
1# conf.py
2html_sidebars = {
3 # "ドキュメント名": ["テンプレート名", "テンプレート名", ...],
4 "**": ["localtoc.html", "relations.html", "sourcelink.html", "searchbox.html"],
5 "using/windows": ["windowssidebar.html", "searchbox.html"],
6}
html_sidebarsを使って、サイドバーに表示する内容をカスタマイズできます。
ドキュメント名とテンプレート名が対応した辞書型で定義します。
ドキュメント名は*(glob-style pattern)を使ってマッチできます。
テンプレート名はstr型もしくはlist型で書きます。
テーマごとによってサイドバーのデフォルト値は異なります。 テーマによってはサイドバー表示が無効になっている場合もあります。
ビルトインのテーマでは、localtoc.html、relations.html、sourcelink.html、searchbox.htmlが表示されます。
それぞれの表示内容は以下の通りです。
localtoc.html現在のドキュメントの目次(見出しのリスト)
globaltoc.htmlすべてのドキュメントの目次(見出しのリスト)
relations.html前と次のドキュメントへのリンク
sourcelink.html現在のドキュメントのソース。
html_show_sourcelink = Trueが必要searchbox.html(簡易的な)検索ボックス
サイドバーをカスタマイズしたい
サイドバーの表示内容と順番だけでなく、そのテンプレートをカスタマイズできるはずです。
どこにテンプレートを置けばいいのか、調べています。
(たぶん_templatesみたいなパスのはず)