可以将 RST 文件理解为 Python 使用的 Markup 文件。
- 直接在pycharm里打开文件夹进行阅读,只不过中文可能成为乱码。
- 将文件后缀名改成md,但原有格式可能显示不出来。
- 在github直接预览
- 安装包
pip install sphinx
pip install sphinx_rtd_theme
在父文件路径下执行,doc表示该路径的子文件名,需替换成你需要 打开阅读 的文件名。
sphinx-build -b html doc build
执行成功后会出现一个build文件,里面放着rst文件生成的html,打开即可阅读