python-sphinx - 指令和条目错误之间缺少空白行

Question

我刚刚使用 Sphinx 创建了我的文档，这是我的问题：最初在 Toc 树指令中是空的，然后我在下面添加“教程”，它看起来像这样：

.. toctree::
   :maxdepth: 2
    tutorial

当我“制作 html”时，我没有在索引页面上获得“教程”。然后我在与 index.rst 相同的目录中创建了一个 tutorial.rst。我再次“制作 html”并收到以下错误消息：

toctree 包含对不存在文档的引用

我该如何解决 ？

Answer 1

也许试试这个：

.. toctree::
   :maxdepth: 2

   tutorial <tutorial>

..

假设您的 tutorial.rst 文件位于 index.rst 文件同一级别的“源”目录中

注意：换行符在目录树选项和页面列表之间很重要。

Answer 2

您必须在 maxdepth 定义和文件名之间有一个空行。