個々のSphinx警告メッセージを無効にする

Question

私は多くの.rstファイルを私のSphinxツリーにあり、意図的にインデックスツリーから除外しています。

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

スフィンクスの特定の警告を抑制するにはどうすればよいですか？

Answer 1

1. 出力に不要な内容の.rstファイルがSphinxプロジェクトにありますか？

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

2. あなたのSphinxプロジェクトには、どのtoctreeにも属していませんが、内容が出力に含まれるべき.rstファイルがありますか？

   警告メッセージを表示しないように、各.rstファイルの先頭に:orphan:を追加します。 http://sphinx-doc.org/markup/misc.html#file-wide-metadataを参照してください。