29

.rstSphinxツリーには、インデックスツリーから意図的に除外されているファイルがたくさんあります。次のような警告が表示されます

 /filename.rst:: WARNING: document isn't included in any toctree

Sphinxで特定の警告を抑制するにはどうすればよいですか?

4

1 に答える 1

43
  1. Sphinxプロジェクトに出力に不要なコンテンツを持つ.rstファイルがありますか?

    exclude_patterns構成変数を使用します。指定されたパターンに一致するファイルについては、出力は生成されません(警告メッセージも生成されません)。http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-exclude_patternsを参照してください。

  2. Sphinxプロジェクトにtoctreeの一部ではないが、その内容が出力に含まれるべき.rstファイルがありますか?

    各.rstファイルの先頭に追加:orphan:して、警告メッセージを抑制します。http://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#file-wide-metadataを参照してください

于 2012-10-28T13:34:25.370 に答える