警告：文件不包含任何toctree的包含文件

Question

我得到警告：

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包含的文件显示？

谢谢！

Answer 1

狮身人面像会抱怨这个文件是否被包含。

但是，您可以使用exclude_patterns配置值明确排除文件。

因此，对于你的情况，你可以尝试这样的：

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

您可以排除个别文件，目录，或使用文件匹配模式，这种方式匹配的文件组。

Answer 2

缩进工作：

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

Answer 3

如果你只想..include::另一个文档的文档，而不必它出现在任何toctree。

将:orphan:添加到文档的顶部以摆脱警告。

这是一个文件级元数据选项，多看这里：

http://www.sphinx-doc.org/en/1.4.8/markup/misc.html#metadata