Sphinx创建空文档

时间:2018-07-19 20:57:47

标签: python documentation python-sphinx

我试图了解如何使Sphinx正常工作。

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

因此,我安装了Python,DocUtils和Sphinx。我在test.rst目录中有C:\Test\。然后,我在该目录中启动cmd.exe并键入:sphinx-quickstart。然后,我按Enter多次以获取默认预设。

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

那么,如何使其起作用?

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

1 个答案:

答案 0 :(得分:1)

您必须在test的{​​{1}}指令中添加toctree

index.rst

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