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

Question

我在Windows 10计算机上使用pyscaffold（https://pyscaffold.org/）创建了一个Python项目。

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

python setup.py docs

仅针对已经包含在docs文件夹中的.rst文件生成文档，但不会从Python源代码生成任何文档。 没有错误报告，只是有关

的警告

Module Reference <api/modules>

说：“警告：文档未包含在包含文件的任何toctree中”。。请注意，api / modules子文件夹中没有生成.rst文件。

Answer 1

Sphinx文档（位于http://howto.nspx.ca/how-to-sphinx.html处警告：“在Windows上，sphinx-autobuild实时服务器可能存在带空格的项目路径问题。如果此命令有错误，请尝试执行以下操作：移动您的项目，使您的标准源路径不包含任何空格。” 。

事实上，我的项目位于的子文件夹中

publicPath

经过一番挖掘，我发现与源代码相关的.rst文件是在以下位置生成的

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

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

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

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

）解决了问题。