警告：文件不包含任何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