問題タブ [toctree]

私は Sphinx を初めて使用し、Sphinx に a を含めようとしていますが、私のオプション toctreeを完全に無視しているようです。toctree

以下に示すようなコードがあります。

これも無視されます。

結果の出力は次のようになります。

• フー
  • ふー1
    • ふー12
  • ふー2
• バー
  • バー1
    • バー12
  • バー2

HTML ドキュメントを生成するために実行make htmlしていますが、conf.py ファイルの設定が間違っている可能性があります。

genindexSphinx は、ドキュメントを作成するときに名前を付けたインデックスを生成するため、その名前をドキュメントに使用することを禁止します。では、その索引へのリンクを目次に含めるにはどうすればよいでしょうか。

私はこれを試しました：

最後の行はドキュメント内のそのインデックスへのリンクを作成しますが、ビルドは TOC の作成時に参照を認識しません。

ドキュメントnumberedには、オプションである「深さを数値引数として与えることにより、特定の深さまで番号付けすることも可能です」と書かれていtoctreeます。しかし、深さを 0 または 1 にしてもうまくいきません。他のアイデアはありますか？

私が働いている場所で Sphinx を使用することを検討していますが、必要なことはすべて実行されているようです。ただし、必要な企業テンプレートと一致させるには問題があります。これには、タイトル ページと目次の間にいくつかの前付ページを挿入する必要があります。

テキストが .rst ファイルのマスター目次の上に配置されている場合、HTML 出力では TOC の上に配置されますが、pdf 出力では TOC の下に移動されます。非表示の目次も追加しようとしましたが、それもうまくいきませんでした。コンテンツは非表示の目次の後にも配置されます。

人々がこのツールを使って本を出版しているので、これが可能でなければならないことはわかっていますが、その方法がわかりません。

Sphinx 1.4.0 および 1.4.1 でこれを試しました。これを機能させるには、latex sty または cls ファイルを追加する必要がありますか? HTML と PDF の両方の出力を使用したいので、使用しない方がよいでしょう。

ありがとう

index.rst に次のような toctree があります。

ここで「api documentation」を使用して行う方法と同様に、toctree の内容をネストすることを検討しています。

したがって、最終的に次のようなものを作成します。

しかし、ドキュメントでこれを行うものを見つけることができないようです。

文書化したいプロジェクトの構造は次のとおりです。

プロジェクトがプロジェクト ツリーで 4 つのドキュメントを参照できる toctreeように、サブディレクトリ (a と b) の sを参照したいと考えています。toctree

ドキュメントが 1 つのディレクトリにある場合はこれを行う方法を知っていますが、サブディレクトリにある場合はこれを行う方法がわかりません。すべてのファイルを 1 つのディレクトリに移動することなく、プロジェクトの構造をそのまま維持しようとしています。私はいくつかの調査を行い、それ .. include:: directiveが進むべき道である可能性があることを発見しましたが、それを適切に使用する方法を理解できませんでした.

私が次のものを持っているとしましょうindex.rst：

そしてnested/index.rst：

TOCを次のようにしたい：

• いくつかの世界的な話題
  • グローバルトピック紹介
  • いくつかのサブトピック

代わりに、次のようになります。

• いくつかの世界的な話題
  • いくつかのサブトピック
  • グローバルトピック紹介

ローカル セクションを最初に表示し、その後にリンク ページを表示するにはどうすればよいですか?