Sphinx 创建空文档

Question

我正在尝试了解如何让 Sphinx 工作。

我不是 Python 开发人员 - 相反，我想将 reST 和 Sphinx 用于通用文本。

所以，我安装了 Python、DocUtils 和 Sphinx。我在C:\Test\ 目录中有test.rst。然后，我在这个目录中启动cmd.exe 并输入：sphinx-quickstart。然后，我多次按 Enter 进行默认预设。

然后我在这个文件夹中有一些新文件，包括make.bat。然后，我运行：make.bat html。然后，创建 Sphinx HTML 文件。但是当我打开index.html 时 - 我看不到我原来的test.rst 的内容。

那么，如何让它工作呢？

（尽管标题完全相同，但我的问题在任何意义上都不是 this 的重复）。

Answer 1

您必须将test 添加到您的index.rst 中的toctree 指令中。

.. toctree::
    :maxdepth: 2

    test

有关其他选项和语法，请参阅 Directives 的文档。