1.准备工作:fork 项目之后,克隆项目到本地,然后新建自己的 git 分支进行编辑
2.建立编译环境: clone 后需要新建 conda 环境: conda create -n spinningup python==3.6
,接着cd docs
,激活 spinningup 环境,安装环境依赖pip install -r docs_requirements.txt
3.编辑文档:文档采用 reStructuredText 语言,可以在这里查看介绍:reStructuredText 简介,翻译完成之后,在docs目录下执行make html
,即可本地预览(生成的预览文件位于 docs/_build/html/index.html)
4.无误之后提交修改到 Github,然后提交 PR。