关于 toctree 引用的警告

Question

Contents:

.. toctree::
   :maxdepth: 2

   foo.rst
   bar.rst

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

我正在尝试使用 sphinx-build 来构建它。 doc 它给了我警告：

(WARNING/2) toctree 引用未知文档 u'bar'

可能是什么原因？

Answer 1

Sphinx 不需要 toctree 指令中的 .rst 扩展名。假设目录树位于 index.rst 和 bar.rst 位于同一目录中，请尝试替换 foo.rst 和 bar.rst 在 toctree 指令中分别与 foo 和 bar 一起使用。

否则，请确保 bar.rst 位于正确的目录中（而不是位于父目录或子目录中）。

Answer 2

我也收到这个错误。对我来说，这是由于缩进。 “toctree”缩进了 3 个空格字符，而我列出的第一个文件则缩进了 4 个空格字符。为了解决这个问题，我们需要有相同的缩进级别。