如何添加目录树条目？

Question

我试图开始使用Sphinx来编写Python文档，但我似乎在开始时遗漏了一些非常基本的步骤

我遵循http://www.sphinx-doc.org/en/stable/tutorial.html并已安装和配置（尽可能使用默认值）该工具

问题是我无法将另一个RST文件链接到索引。我的索引文件如下：

Welcome to FirstProject's documentation!
====================================
.. toctree::
   :maxdepth: 2

intro

请注意，intro.rst与以下内容位于同一目录中：

Introduction to the FirstProject project!!
======================================

.. toctree::
    :maxdepth: 2

输出类型为html。当我尝试

make html

我收到一条警告说：

/home/ngk/Code/Projects/Twitter/botscore/doc/intro.rst: WARNING: document isn't included in any toctree

我希望在index.html中创建一个带有“intro”字符串的超链接，链接指向intro.html

相反，index.html文件中的预期位置中只有一个字符串“intro”。请注意，intro.html文件是创建的，但不是从index.html超链接的

有人能告诉我我错过了哪一小步吗

Answer 1

问题似乎是Sphinx doc希望在包含的RST的每行开始处有3个空格。如下所示更改我的index.rst修复了该问题

.. toctree::
   :maxdepth: 2

   intro

斯芬克斯文档似乎对空格的确切数目很敏感。我尝试使用更少的标签空间，也尝试使用tabspace，但都不起作用

希望这对其他遇到这个问题的人有用

编辑： 只要toctree中的每个条目都有相同数量的空白，它也可以处理其他数量的空白