如何添加目录树条目？ [英] How to add a toctree entry?

问题描述

我正在尝试开始使用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中会创建一个带有‘the troo’字符串的超链接，该链接指向Intro.html

相反，在index.html文件中的预期位置只有一个字符串‘INTRO’。请注意，Intro.html文件已创建，但不是来自index.html的超链接

有人能建议我错过了看似很小的一步吗？

推荐答案

看起来问题在于Sphinx-DOC在包含的RST的每一行的开头都应该有3个空格。按如下方式更改我的index.rst解决了该问题！

.. toctree::
   :maxdepth: 2

   intro

Sphinx-Doc似乎对空格的确切数量很敏感。我尝试使用较少，也尝试使用制表符，但都不起作用。

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

编辑： 它也适用于其他数量的空格，只要toctree中的每个条目都有相同数量的空格。

这篇关于如何添加目录树条目？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！