web-dev-qa-db-ja.com

警告：ドキュメントは、インクルードファイルのtoctreeに含まれていません

私は警告を受けています：

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経由ではなく明示的に含まれているファイルに対して常に表示されますか？

ありがとう！

python-sphinxrestructuredtext
45
NickChase

Sphinxは、ファイルが含まれているかどうかにかかわらず、これについて文句を言います。

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

したがって、あなたの場合、次のようなものを試してみてください：

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

この方法で、個々のファイル、ディレクトリを除外したり、ファイルのグロビングパターンを使用してファイルのグループを一致させることができます。

EDIT：参照： Joakim's answer この回答の作成後に追加された別のオプションについて。

26
Kevin Horn

toctreeに表示せずに、別のドキュメントのドキュメントを..include::だけしたい場合。

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

これはファイル全体のメタデータオプションです。 Sphinx documentation から詳細を読んでください。

38
Joakim

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

  toctree::   
   :maxdepth: 2
       hello <h.rst>
       abc <your.rst>
2
diveinsky