python - Windows 10 上的 pyscaffold：未生成 Sphinx 模块文档

Question

我在Windows 10 机器上使用 pyscaffold ( https://pyscaffold.org/ ) 创建了一个 Python 项目。

尝试通过命令生成文档时：

python setup.py docs

该文档仅针对已包含在 docs 文件夹中的 .rst 文件生成，但没有从 Python 源代码构建文档。没有报错，只是一个警告

Module Reference <api/modules>

说：“警告：文档不包含在包含文件的任何目录树中”。需要注意的是，在 api/modules 子文件夹中没有生成 .rst 文件。

标签： pythonwindows-10python-sphinx

Answer 1

Sphinx 文档（位于http://howto.nspx.ca/how-to-sphinx.html）警告说：“在 Windows 上，sphinx-autobuild 实时服务器可能存在项目路径带有空格的问题。如果出现错误从此命令中，尝试移动您的项目，使您的完全合格的源路径不包含任何空格。” .

事实上，我的项目位于

C:\Users\User\Documents\Visual Studio 2015\

经过一番挖掘，我注意到与源代码相关的 .rst 文件是在

C:\Users\User\Documents\Visual\api\modules

因此，问题肯定与项目路径中的空白有关。

将整个项目移动到路径没有空格的文件夹中（例如：

C:\Users\User\Documents\Projects

) 解决了这个问题。