Мы используем Sphinx для документации в нашей среде python Linux/OSX, но у нас есть кто-то из Windows, который хотел бы иметь возможность получить среду, в которой они могут редактировать и создавать документацию Sphinx.
Можно ли настроить Sphinx на окна? Я предполагаю, что сложная часть заключается в установке среды python и всех зависимостей, но у меня есть 0 опыт работы с python на окнах, чтобы кто-то мог указать мне на простой способ продолжить.
Для установки python на windows загрузите Python. Запустите исполняемый файл и все установлено.
Если у вас установлен протокол, вы можете открыть командную строку и просто ввести
pip install -U Sphinx
Если у вас нет установленного пакета, вам сначала нужно его установить, используя в командной строке следующее:
python -m pip install -U pip
Теперь вы можете использовать pip-win, чтобы легко настроить sphinx в virtualenv на окнах.
Сначала загрузите и установите Python. Если вы хотите использовать конструктор latexpdf, вам также потребуется установить TeX Live или MiKTeX для окон.
Затем запустите pip-win.exe. Он автоматически вытащит необходимые настройки setuptools и установит pip и virtualenv в вашей системе. Когда он загружается, он подтягивает установленный Python, но если вы установили его в другое место, отличное от каталога по умолчанию, вы можете легко ввести абсолютный путь или просмотреть его.
Далее, в строке Command: вы можете создать новый virtualenv, введя:
venv -c C:\foo\sphinx-venv
Это откроет вам командную строку внутри вашей виртуальной машины. После этого вы можете установить sphinx с помощью команды pip:
<sphinx-venv> C:\foo\> pip install sphinx
Теперь sphinx устанавливается на вашем компьютере Windows в виртуальной среде. Вы можете использовать деактивировать, чтобы избежать новой среды.
Когда вы захотите снова ввести свой виртуальный диск, чтобы создавать больше проектов сфинксов, вы можете либо открыть команду win-win и запустить:
venv C:\foo\sphinx-venv
Или вы можете создать собственный файл python, чтобы активировать среду sphinx и создать свой файл sphinx, например:
import os
os.system("cmd /c \"CALL C:\\foo\\sphinx-venv\\Scripts\\activate.bat && make html\"")
Самым простым способом использования Python в Windows является WinPython, который представляет собой переносимый дистрибутив, который так же прост в использовании, как любое другое портативное приложение. Это даст вам значок командной строки WinPython, из которой вы можете использовать pip и т.д., Как если бы в любой другой (например, Linux) системе, или вы можете загружать пакеты и устанавливать их с помощью панели управления WinPython.