問題タブ [toctree]

ドキュメントの複数の「レベル」をドキュメント化する方法でスフィンクスを使用しようとしています。

• API リファレンス
• マニュアル
• チュートリアル
• 等。

目次は、現在のセクションに関連するサイドバーに表示されるという考え方です。したがって、メインのインデックスにいるときは、上記のセクションのみが表示されます。あなたが入るとき。「マニュアル」は、そのセクションに固有の別の目次と、メインの目次に戻る方法を示しています。

ハッキングせずにSphinxでこれを機能させる方法を見つけようとしていますが、今のところ方法がわかりません。フォルダー構造はすでにさまざまなセクションを反映しており (つまり、すべての「マニュアル」ドキュメントは _source/manual の下に保存されています)、これらの各ディレクトリに個別のインデックス ファイルを配置しようとしましたが、toctree 機能はメイン インデックス ファイル。

「readthedocs」テーマを使用しています。具体的に見ているコードはhttps://github.com/snide/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html#L93です

Sphinx を使用してこのような ToC を追加する方法を誰か教えてもらえますか?

ありがとうございました

スフィンクスの toctree にメイン (index.rst) ページを含めたいと思います。ドキュメントは、「自己」を含めることでこれを行うことを示唆していますが、スタックオーバーフローで他の人が指摘したように、これにはメインページのタイトルのみが含まれるため、深さ> 1の場合、メインページの動作はリンクされたページとは異なります。

この問題で提案されているコンテンツ ディレクティブも見てきました。toctree で一貫した動作を生成するソリューションを本当に探しています。ありますか？

generated/ライブラリの API を文書化するために sphinx-apidoc と autosummary 拡張機能を使用していますが、以下のオプションの目的を本当に理解できません。

これはSphinxのドキュメントであり、パンダのようなライブラリにあります。私は使用toctreeしていて、API は自動生成されていますが、何が生成されたのかわかりません。生成されたというフォルダーが表示されず、これの利点/目的がわかりません。

ありがとう

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

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

sphynx を使用して、静的な .rst ファイルからドキュメントを生成します (ドキュメント文字列の抽出はありません)。

リポジトリに 2 つのファイルがあります。

index.rst

とintro.rst

以下は、実行して取得した pdf のスクリーンショットですsphinx-build -b latex . _build; cd _build; pdflatex *。

フラバガスティングか何か？

これが可能かどうかはわかりません。しかし、複数の .rst ファイルをディレクトリに配置し、コンパイル中に配置したいと考えています。これらのファイルを自動的にtoctree. これについてどうすればよいですか？

Sphinx ドキュメントの左側のメニューにセクション タイトルを追加する方法はありますか? MkDocs (たとえば、こちら)を使用すればできることはわかっていますが、Sphinx および ReSTRuctured テキストでこれを行う方法はありますか?

ドキュメントを個別のセクション (インストール手順、プログラムの実行など) に分割し、それらのセクションのタイトルを左側のメニューにテキストとして表示したいと考えています。