使用Sphinx阅读rst格式的文档

背景

Sphinx是一个开源软件，可以生成python项目的文档，在很多github上的项目，当你打开doc下的相关文档文件时，往往可以看见rst格式的文件，这些文件就是用sphinx自动生成的

如何阅读

安装

首先安装sphinx组件

pip install sphinx

在项目的doc中，可以阅读里面conf.py的代码，可以看到一些你需要安装的额外组件，比如
可以安装

pip install sphinx_rtd_theme

和

pip install sphinx-argx

使用

在安装结束后，在doc的上级目录下，运行如下命令即可

sphinx-build -b html docs build

其中docs为文档所在位置，build则为生成的目录