文档工具Sphinx的安装


1.在Windows 10、Windows 11下配置Sphinx + make环境
 

a) 安装最新的Windows版Python3。

b) 在PowerShell中(Win11叫Windows Terminal),用以下命令安装Sphinx:
  pip install -U sphinx

c) PowerShell不包含make,需要安装MSYS。不过,很多MSYS所带的make无法识别路径中的符号“\”。这里给一个MSYS-cn项目下载地址:https://code.google.com/archive/p/msys-cn/
把MSYS-Update.7z解压缩后就可以使用,例如放在C盘根目录下。
  MSYS-cn带有两个make.exe,分别位于目录 C:\MSYS\bin 和 C:\MSYS\mingw\bin ,其中支持“\”的是后一个。

d) 把后一个make的路径加入用户的环境变量。依次打开Windows 10/11的“设置/系统/关于/高级系统设置”,在跳出的“系统属性”文本框中依次找到“高级/环境变量”,编辑其中的用户变量Path,把 C:\MSYS\mingw\bin 加入其中。如果Path中还存在其它MSYS的路径,需要把顺序下移。

e) 现在可以在PowerShell中用make编译rst文档了。但是可能一开始会报错说缺少各种Sphinx有关的Python包。根据提示,用
  pip install 包名称
  命令把它们全装上,直到不再报错。