sphinx doc 本地开发环境部署

本地开发环境配置

以下内容面向 Windows 10 系统进行介绍

以下内容中的代码块有 > 提示符的行，均为在 Powershell 中执行的命令。

Python 安装

Windows 10 下载安装 Python 3.8，采用安装向导提供的推荐选项安装即可。

设置国内 Pypi 源

运行 Powershell 终端：执行以下两条命令，第一条是升级 pip，第二条是将 pip 的默认软件源修改为国内的镜像。

> pip install -i https://pypi.tuna.tsinghua.edu.cn/simple pip -U
> pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple

注意 > 为终端命令提示符，不是命令。

安装 Shpinx 及相关包

> pip install -U Sphinx sphinx-rtd-theme jieba

编译 HTML 网页

在项目根目录下（即 make.bat 文件所在目录）执行命令：

> .\make.bat html

编译后的文件位于 _build/html 目录下。