Sphinx 环境搭建
配置环境:
1. 安装
使用 pip install Sphinx 安装,如果国内站点访问比较慢,请使用镜像站点下载,可通过下面的命令行安装:
pip install Sphinx -i http://mirrors.tuna.tsinghua.edu.cn/
安装完成后,可在 Python/Scripts/ 目录下看到以下程序:<p>
- sphinx-quickstart.exe <p>
- sphinx-build.exe <p>
2. 配置程序路径
参照 Python2/3共存的方法,可在对应的 Python 文件夹中执行如下操作
建立空白文本文档并重命名为 sphx_qs.bat ( .bat 前名称可自定义),在此文件中添加下行:<p> Python 安装路径\Scripts\sphinx-quickstart.exe %*
建立空白文本文档并重命名为 sphx_bd.bat 在此文件中加入
Python安装路径\Scripts\sphinx-build.exe %*
3.配置文档
在文档的根目录下,运行控制台程序,输入步骤2中配好的 sphinx-quickstart 对应的.bat文件名,执行 sphinx-quickstart 程序后,会生成如下文件:
- Makefile:构建配置文档
- conf.py 控制 Sphinx 读取源文件生成目标文档的配置文件。
- index.rst 索引文件
4.生成HTML文件
在控制台输入 sphx_bd -b html 源目录 文件生成目录,可生成对应的的 html 文档。