問題タブ [toctree]

ライブラリの 1 つでドキュメントを増やしたいと考えています。私はスフィンクスを使ってドキュメントを作成してきましたが、最近は autodoc 拡張機能の調査を開始しました。

ほとんどの専門的なドキュメントのように、各クラスのドキュメント ページには、ドキュメント化されたすべてのメソッドのリストが上部にリンク付きで表示されます。または、言い換えれば、より詳細なメソッド ドキュメントのそれぞれへのハイパーリンクを含むトップの toctree です。

autodoc で文書化されているクラスごとに、この toctree を自動的に作成する方法はありますか?

私のスフィンクスのドキュメントには、(もちろん) toctree の一部にする必要があるいくつかのマイナーなページがありますが、それらを適切な場所にリストすることができません。

「セクション 3」ページが次のようになっている場合:

次に3.3とが の前に3.4リストされます。 3

他の順列を試しましたが、どれもうまくいかないようです。

1. 3見出しの後に toctree を配置すると、3.3との間に3.4リストされます。 33.1
2. ページの最後に toctree を配置すると、すべてが正しい順序になりますが3.3、3.4section の子である第 3 レベルのセクションになります3.2。

ここに具体的な例を挙げました：

• http://sphinx-problem.readthedocs.org/en/latest/
• https://github.com/bukzor/sphinx-problem

私は 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を次のようにしたい：

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

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

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

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

ページのコンテンツといくつかの外部リンクをtoctreeSphinx ドキュメントに正しい順序で含める必要があります

これが私の構造であるとします：

次に、結果の toctree は次のとおりです。

• テスト
• ページ1
• ページ2

しかし、私はそれが必要です

• ページ1
• ページ2
• テスト

したがって、toctree の順序を変更するか、含まれているページを手動で toctree に追加する方法が必要です。これも問題ありません。

現時点で思いついた唯一の「解決策」は、ダミードキュメントを含めることです。しかし、それはユーザーにとってあまり良いナビゲーション パスとは言えません。

注: この質問は、このhttps://stackoverflow.com/questions/35659349/sphinx-place-minor-pages-in-the-right-place-in-the-toc/35672388#35672388に部分的に関連しています。