48

Sphinx で HTML ドキュメントを生成しています。

ドキュメント内の各 HTML ページのサイドバーを変更して、toctree を含めるにはどうすればよいですか? デフォルトでは、toctree はmaster_docページにのみ表示され、サイドバーではなくメイン エリアにのみ表示されます。

これを行う簡単な方法はありますか?生成されたドキュメントをホストするために readthedocs を使用するので、readthedocs でも利用できる場合を除き、サードパーティのプラグインの使用は避けたいと思います。

4

3 に答える 3

61

で HTML サイドバーをカスタマイズできますconf.py

デフォルトの HTML サイドバーは 4 つのテンプレートで構成されています。

['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']

conf.pyのように localtoc.html を globaltoc.html に変更できます。

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

これは最終的に HTML ファイルで使用されるため、ReadTheDocs で動作するはずです。

于 2013-09-25T14:12:30.240 に答える