python很多开源代码的文档都是使用.rst编写的,此处记录第一次在windows下配置环境并成功编译.rst文件为html文件
1.配置环境:(首先默认已安装python)
打开cmd:(依次安装以下)
pip install sphinx sphinx-autobuild
pip install restructuredtext-lint
如果懒得配置环境变量的同学(比如我),就需要打开git bash来使用linux环境,但可能直接在cmd里也可(但没试过)
因为本人尝试时不知为何sphinx被以管理员权限安装,所以需要以管理员权限运行git bash,然后一直cd到需要编译目录的父目录下
然后在父目录下执行编译:docs是要编译的目录名称,编译为html格式
sphinx-build -b html docs build
第一次编译提示需要安装sphix_rtd_theme
那就安装:(很多时候linux的命令行提示都可以稳准狠地解决问题)
安装之后再次执行:
sphinx-build -b html docs build
成功~
原始的rst文件:
生成的html文件:
点击html文件:(浏览器自动打开)