rst 文件打开方式

rst 文件打开方式

    rst(ReStructuredText) 是一种用于文本数据的文件格式，主要作为 Python 编程语言技术文档的描述语言，其旨在为 Python 创建一组类似于 Java 的 Javadoc的功能说明文档；Docutils 可以从从 Python 程序中提取注释和信息，并将它们格式化为各种形式的程序文档，rst就是其中的一种。

    rst一般组织在python源文件的doc/docs目录下，可以通过sphinx工具将rst文件转化为html文件易于阅读。 sphinx可以通过pip进行安装，他的可执行文件在python安装目录下的Scripts，安装过Anaconda的sphinx已经安装，可以直接打开Anaconda的命令行，执行以下命令：

# pip install sphinx
sphinx-build -b html docs build
# 进入源文件目录（docs的上级目录），docs是rst所在的文件夹
# build是输出html的目录

​ 可能出现的错误 Could not import extension sphinxcontrib.log_cabinet， 安装模块即可：

pip install sphinxcontrib-log_cabinet
# 指定清华镜像源： -i https://pypi.tuna.tsinghua.edu.cn/simple

    执行完转换命令后，一般从build/index.html进入，通过浏览器查看（这个其实就是源码官网的文档说明，转化后相当于本地缓存）。