如何添加toctree条目

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

我希望这个超级链接带有＆＃39; intro＆＃39; string将在index.html中创建，链接指向intro.html

相反，只有一个字符串＆＃39; intro＆＃39;在index.html文件中的预期位置。请注意，intro.html文件已创建，但未从index.html

进行超链接

有人可以建议我错过了一个看似很小的步骤吗？

Answer 1

看起来问题是Sphinx-doc在所包含的RST的每一行的开头都期待3个空格。改变我的index.rst如下修复了问题！

.. toctree::
   :maxdepth: 2

   intro

Sphinx-doc似乎对空格的确切数量很敏感。我尝试使用更少的，并尝试使用tabspace，但都没有工作。

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

修改 它也适用于其他数量的空格，只要toctree中的每个条目具有相同数量的空格。