python - [ドキュメントを読む] サイドバーに toctree 全体を表示する

Question

私の理解では、新しい Read The Docs テーマは toctree から深さ 2 のサイドバーを生成します。私のドキュメントは比較的深く、深さ 2 では十分ではありません。どうすればこの制限を増やすことができますか、できれば完全に削除できますか?

それが合理的に不可能な場合、グローバル toctree の代わりにローカル ToC を使用するにはどうすればよいですか?

Answer 1

注：以前の回答は古くなっています。@Ariel がコメントで指摘しているmaxdepthように、 を設定することで を設定できるようnavigation_depthになりましたhtml_theme_options。READMEに従って、プロジェクトの conf.py でこれを変更します。

html_theme_options = {
    'navigation_depth': 4,
}

---

Github のテーマのソースを見ると、目次の深さがsphinx_rtd_theme/layout.html の 93 行目にハードコーディングされているようです。そのため、テーマをオーバーライドするためにテーマを構成することはできません。

toctreeこの行はハードコードされているため、次の行で「サポートされている」ローカルの toctree ではなく、常にグローバルな toctree が返されます。

もちろん、テーマをフォークして、ローカルで使用するためにその行を変更することもできます (RTD でカスタム テーマを使用できるので、そこでも動作するはずです)。デモテーマでやってみました。だとこんな感じmaxdepth=3になるので、追加のCSSが必要かもしれません。テンプレート関数のドキュメントでは、toctree無制限の深さを指定するには、単純に を渡しmaxdepth=-1ます。これは TOC のサブレベルに折りたたみ/展開を追加しないことに注意してください。

プル リクエストの良いターゲットになる可能性はありますか?

Answer 2

少なくとも ReadTheDocs では、この動作をカスタマイズする方法はありません。ただし、ページ内の追加の詳細レイヤーを読むことはできますが、ナビゲーションには表示されません。