pyscaffold в Windows 10: документация для модуля Sphinx не создается

Question

Я создал проект Python, используя pyscaffold (https://pyscaffold.org/) на компьютере с Windows 10.

При попытке сгенерировать документацию с помощью команды:

python setup.py docs

документация генерируется только для файлов .rst, уже включенных в папку docs, но документация не создается из исходного кода Python. Об ошибках не сообщается, только предупреждение о

Module Reference <api/modules>

поговорка: "ВНИМАНИЕ: документ не включен ни в одно дерево для включенного файла" . Следует отметить, что .rst файл не создается в подпапке api / modules.

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

) решил проблему.