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實時服務器可能存在帶有空格的項目路徑問題。如果出現錯誤從此命令，嘗試移動您的項目，以便您的完全限定的源路徑不包含任何空格。“ 。

確實，我的項目位於。的子文件夾中

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

經過一番挖掘，我注意到與源代碼相關的.rst文件是在生成的

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

因此，問題肯定與項目路徑中的空白區域有關。

將整個項目移動到路徑沒有空格的文件夾中（例如：

C:\Users\User\Documents\Projects

解決了這個問題。