問題タブ [toctree]

ページのコンテンツといくつかの外部リンクを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に部分的に関連しています。

Read-The-Docs テーマを使用するプログラムで生成された sphinx-doc ソースがあります。ソース ツリーは次のようになります。

index.rst次のような TOC が含まれます。

すべてのmodel_search.rstモデルが含まれますindex.rst:

最初に でソースをビルドするとmake html、うまくビルドされ、既存のすべてのモデルを含む TOC が作成されます。

ただし、新しいモデル (例: 3lin) を追加すると、既存のモデル ( 、など)make buildのページで TOC が再生成されません。すべてのページで TOC を正しく再作成する唯一の方法は、関連するすべてのファイルを変更するか(たとえば、有効化/無効化)、または手動で行うことです。1lin2linconf.pyautodoctouch.rst

古いモデル ページで TOC を再生成する必要がありますか、それともこれは予期された動作ですか? もしそれが起こっているとしたら、何が間違っているのでしょうか?

テーマを使用して、ReadTheDocs で Sphinx を使用してドキュメントを作成しています。ビルド プロセスは、次のように参照できる genindex.html ファイルを生成します。

以下を作成します。

目次ページへリンクします。

genindexたとえば、次のように toctree に追加できません。

これは自動生成されたファイルであり、レンダリング時には存在しないためです。さらに、Sphinx は genindex が というローカル ファイルであることを想定していますgenindex.rst。

ToC / ナビゲーションに追加するにはどうすればよいですか?

make htmlドキュメントの HTML ( ) および PDF ( make latexpdf) バージョンを生成するために使用する sphinx ドキュメント プロジェクトがあります。一部のページを整理するためにサブディレクトリを使用しています。私のディレクトリ構造は次のようなものです：

両方の index.rst ファイルで指定された toctree があります。

HTML を生成すると、subsection1/indexページには適切なページへのリンクを含む TOC リストがあります。ラテックス PDF を生成すると、サブ toctrees は無視され、何も出力されませんが、HTML と同じにしたいと考えています。

私はラテックスの経験があまりなく、これについてオンラインで何かを見つけるのに苦労しているので、明らかな何かが欠けているように感じます. 私は調べましたが.. contents::、もちろん、これはHTMLで必要なものを生成しません。大量の部品.. include::を用意する必要がないことを望んでいました... only::

Python モジュールのドキュメントを作成するために Sphinx を使用しています。

ページに字幕を追加したいのですが、 toctreeには表示したくありません。

小さなセクションと短い (数行の) 説明が必要です。すべてのセクション タイトルをtoctreeに追加すると、ドキュメントの閲覧が非常に難しくなります。

これが私のindex.rstです:

いくつかの字幕を追加したい:

ドキュメントを確認しましたが、どのタイプの下線を使用すればよいかわかりません。タイトルを<h4>またはに変換する特別な下線があるかどうかわからない<h5>

github README.mdで文字を追加する#と、タイトルが小さくなります。*.rstに相当するものは何ですか?

ビルド ドキュメントはここにあります。サブタイトルはドキュメントの現在の構造を台無しにするため、含まれていません。