sphinx文档给了我关于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 references unknown document u'bar'

可能是什么原因？提前谢谢。

Answer 1

Sphinx不需要toctree指令中的.rst扩展名。假设toctree类似于index.rst且bar.rst位于同一目录中，请尝试使用foo.rst和{{替换toctree指令中的bar.rst和foo 1}}分别。

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

Answer 2

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