Sphinx を使用して、rst ファイルから pdf ファイルを生成しています。Sphinx は、レベル 3 の見出しまでのセクション番号と、このレベルまでの目次を自動的に生成します。ただし、すべてのレベルの見出しに番号を付けて TOC に含める必要があります。そのために、私は使用しようとしています.. sectnum:: ( http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents )。結果はまさに私が期待したものではありません:

1. TOC とテキストの両方で、すべてのセクション番号の前に番号 1 が追加されています。つまり、1 ではなく 1.1 であり、2 ではなく 1.2 です。

2. TOC と第 3 レベルの見出しまでのテキストの両方で、セクション番号が繰り返されます。つまり、セクション番号 (正しいもの) が間違ったもの (先頭に 1. が追加されたもの) の前にあります。

サンプルの最初のファイルは次のとおりです。

TOCの結果は次のとおりです。

（結果を表示するためにPDFファイルのショットを撮りましたが、評判が10必要なため、画像を投稿できないことがわかりました。投稿するのはこれが初めてです）

テキストの結果は次のとおりです。

ご覧のとおり、セクション番号に 1. が追加されており、レベル 3 までの見出しの繰り返し部分があります。

「sphinx-quickstart」で作成されたバニラのスフィンクス プロジェクト (Sphinx 1.2b3.) があります。

4 つのヘッダー レベルを持つ基本的な page.rst を追加します。

index.rst で html toc の深さを制御できます。

ドキュメントhttp://sphinx-doc.org/latest/markup/toctree.htmlに基づいて、次のように conf.py を調整します。

それから私は構築します：

html は予想どおりレベル 1 のみを表示しますが、pdf は 2 つの toc レベルを表示し続けます - スクリーンショット:

ヒントはありますか？

どうも

ペレ

解決

ジェイコブによって提供されました -> 単に必要なレベル num -1 と考えてください:

localhost でreadthedocs.orgインスタンスを使用して、 github リポジトリから HTML ドキュメントを作成しています。次のことができるようにしたいと考えています。

現在、次のような toctree の glob 機能を使用して読み取られるファイルのリストがあります。

しかし、特定のファイルを toc にリストすることを避ける必要があります。

セクションの:hidden:下に追加しようとしましたが、すべてが非表示になります。:glob:

可能な限り多くのドキュメントを調べましたが、これら 2 つのオプションを一緒に使用した例はどこにも見つかりませんでした。

これを達成する方法はありますか？

ドキュメントのフロント ページのサブセクションを表示するための目次 (TOC) の取得に問題があります。

フロント ページにいくつかのセクションがあり、それらを TOC に表示したいと考えています。サブセクションの表示は、TOC に含まれる他のすべてのページでは正常に機能しますが、それ自体では機能しません。

私のindex.rstコード:

TOC で期待するのは次のようなものです。

• 題名
  • サブセクション
  • コンテンツ
• 発達
  • サブセクション

代わりに私が得るのはこれです：

• 題名
• 発達
  • サブセクション

これまでに 1 つの解決策を見つけましたが、満足できるものではありません。すべてのコンテンツを別のページに配置し、ディレクティブindex.rstを使用してコンテンツを含め、別のページを TOC に配置できます。.. include:これにより目次は正しく表示されますが、重複したページが作成され、ナビゲーション (前/次のページ) に含まれるようになりました。

特定のタグが設定されている場合にのみ、自分のファイルの 1 つを Sphinx TOC に含めたいのですが、明らかな方法は失敗します。

これを達成する簡単な方法はありますか？

次のような子ドキュメントを含む Sphinx マスター ドキュメントがあります。

TOC をパーツまたはサブセクションに分割して、次の行に沿ってレンダリングしたいと思います。

私の現在のアプローチは、TOC に実際のドキュメントをリストする疑似子ドキュメントを作成することです。たとえば、「part1.rst」には次のようになります。

次に、マスター文書で:

これの問題は、「part1」のリンクをクリックすると、実際のコンテンツのないページ (「part1.rst」) に移動することです。

他のアプローチはありますか？

または、「part1.rst」のエントリがページ リンクを生成しないようにする方法はありますか?

私はSphinxで非常に基本的なセットアップをしています。TOC は次のとおりです。

ファイル 1 と 2 は次のようになります。

1つ目

2 つ目:

両方のファイルのフォーマットは同じで、最終的に次の構造にしたいと思います

しかし、スフィンクスは私に与えます

ファイルを分割する理由は、ファイルがかなり大きく、簡単に編集できるように小さくしたいからです。同じ見出しスタイル (同じ上線/下線文字) を別のファイルで取得するにはどうすればよいですか?

javadoc を使用していくつかの HTML ファイルを作成しました。私はSphinxディレクトリにそれらを持ってい_staticます。今、これらの HTML ファイルへのリンクを Sphinx に入れようとしていますtoctree:

これを行う方法はありますか？私が試した限り、Sphinx は .xml の reST ファイルのみを受け入れますtoctree。

利用時にサイドバーに自動生成された目次へのリンクが欲しいsphinx-rtd-theme。私はそれをtoctreeに追加しようとしました:

しかし、これは

スフィンクスから、他の効果はありません。

単純にテーマ ファイルにインデックスをハードコードすることもできると思いますlayout.htmlが、標準のテーマを変更する以外に、もっと良い方法があるのではないでしょうか?

ヒントはTIAまで！

Sphinx ユーザー ガイドの構成で問題が発生しています。章の見出しと概要を含むメインのランディング ページ (index.rst) を作成し、別のファイル (part1.rst、part2.rst) に含まれる個別のサブセクションを作成して、章を形成したいと考えています。「toctree」を使用して個別のサブセクションを挿入しようとしていますが、toctree が概要セクションに吸い込まれてしまうというネストの問題が発生しています。（注：..include::異なるWebページに表示されるサブセクションを順番にリンクしたいので、ディレクティブを使用していません。また、適切に構造化して、UGのPDFでレンダリングされたバージョンでうまくレイアウトしたいのです）。

index.rst

part1.rst

part2.rst

結果の構造を次のようにしたいと思います。

しかし、私が得ているのは

ファイルの最後に含めた toctree は、メインの章のコンテキストではなく、「概要」セクションに分類されているようです。ファイルの先頭に toctree を挿入しようとしましたが、次の順序になります。

これを適切に行う方法があるに違いないように思えますが、Sphinx のサイトや SO では何も見つかりませんでした。どんな助けでも大歓迎です。