有关toctree引用的警告

问题描述 投票:4回答:2
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'

可能是什么原因?

python python-sphinx toctree
2个回答
3
投票

Sphinx在toctree指令中不需要.rst扩展名。假设toctree位于index.rstbar.rst在同一目录中,请尝试分别用foo.rstbar.rst替换toctree指令中的foobar

否则,请确保bar.rst在正确的目录中(而不是在父目录或子目录中。)>


2
投票

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

© www.soinside.com 2019 - 2024. All rights reserved.