75

警告が表示されます：

WARNING: document isn't included in any toctree

明示的に含まれているため、ドキュメントに存在するファイルの場合。だから私はインデックスファイルを持っています:

.. toctree::
    :maxdepth: 2

   pages/0010-foo
   pages/0020-bar

ファイル 0020-bar.rst には、次のように他の多くのファイルを具体的に含めています。

.. contents:: :local:

.. include:: /pages/reference-architecture/technical-considerations/0070-baz.rst

しかし、プロジェクトをビルドすると、次のように 0070-baz.rst がどの toctree にもないという警告が表示されます。

/home/nick/Documents/myProject/docs/pages/reference-architecture/technical-considerations/0070-baz.rst:: WARNING: document isn't included in any toctree

奇妙なことは、出力の内容を確認できることです。これは正常ですか？この警告は、toctree 経由ではなく、明示的に含まれているファイルに対して常に表示されますか?

4

4 に答える 4

67

..include::ドキュメントを別のドキュメントに表示したいだけで、 toctree.

ドキュメントの先頭に追加:orphan:して、警告を取り除きます。

これは、ファイル全体のメタデータオプションです。詳細については、Sphinx のドキュメントを参照してください。

于 2016-11-21T17:24:55.117 に答える
44

Sphinx は、ファイルが含まれているかどうかに関係なく、これについて文句を言います。

ただし、exclude_patterns 構成値を使用して、ファイルを明確に除外できます。

したがって、あなたの場合、Sphinx のconf.pyファイルを次のように変更してみてください。

exclude_patterns = ['pages/reference-architecture', 'some/other/file.txt']

この方法で、個々のファイルやディレクトリを除外したり、ファイルのグロビング パターンを使用してファイルのグループを照合したりできます。

編集:参照:この回答が作成された後に追加された別のオプションに対する Joakim の回答。

于 2013-03-15T17:48:40.487 に答える
6

git サブモジュールとして取り込もうとしていたドキュメントを編集できない状況がありました。ドキュメントには、Markdown で記述された TOC ページを含む独自の構造が既にあり、フォーマットの一貫性のために sphinx で処理する必要がありました。

私ができることがわかったのは、非表示の toctree を指定して toctree にドキュメントを認識させることですが、toctree を混乱させたり、Sphinx ビルド出力に大量のエラーを追加したりしないでください。

* :doc:`Additional Book <external/index>`

.. toctree::
   :hidden:

   external/documentA.md
   external/documentB.md
于 2020-03-02T14:56:15.730 に答える
2

インデントが機能しました：

  toctree::   
   :maxdepth: 2
       hello <h.rst>
       abc <your.rst>
于 2015-09-21T07:05:04.207 に答える