rst格式文件转换成html格式文件

本次只涉及到windows中将rst文件转成html文件。

1、首先,我们需要保证你的机器上安装了python,我装的是python2.7,可以去官网上进行下载。

2、下载Python包SetupTools

检查Python目录下的子目录Scripts是否存在easy_install.exe文件,如果存在请继续第三步,不存在请下载https://pypi.python.org/pypi/setuptools zip包,解压后放到Python安装的根文件夹下面,并该目录加入到环境变量中。

3、安装Sphinx

启动CMD,并运行命令”easy_install sphinx”,该过程需要一段时间,安装过程中如果出现warning并且安装等待时间过长(一般不超过三分钟),可以按键盘的任意键,继续运行,直到安装完成。

rst格式文件转换成html格式文件

4、安装sphinx_rtd_theme

在cmd中运行“pip install sphinx_rtd_theme”,安装相应的模块。(如果你已经安装可以忽略这一步)。

5、准备rst文档及相关目录

目录结构包含如下,其中docs文件夹包含rst文件。Conf.py存放sphinx-build命令的相关参数,可以根据模板自己文档内容进行修改。

rst格式文件转换成html格式文件

其中en_US文件夹中包含rst文件。

6、编译rst文件成html文件

在rst文档所在的项目目录(我的是en_US)下运行cmd,运行“sphinx-build -b html ./docs/ ./html/”, 运行结果如下,出现的这些红色的警告信息不用管。

rst格式文件转换成html格式文件

编译完成后,可以看到en_US文件夹下多出一个html文件夹,该文件夹下就是生成的html文件。至此,rst文件转换成html文件就完成了。

rst格式文件转换成html格式文件