Web

为Github项目创建文档


安装工具

1
pip install sphinx sphinx-autobuild

克隆Github项目到本地

1
git clone https://github.com/yourname/yourrepo.git

创建文档目录

1
2
3
4
cd yourrepo
mkdir docs && cd docs
sphinx-quickstart
# 按提示一路下去，会生成index.rst和conf.py以及一些其他的目录和文件

编辑index.rst文件

生成html文件 make html

推送到Github git push 可能需要输入用户名和密码

生成文档

  • 注册并登陆 Read the Docs
  • 设置 - Connected to Github //关联Github账号
  • 导入 - Import a Project //会自动列出Github上的仓库名，没有的话也可以手动导入，按提示生成即可
1.如果本文帮到了您，不妨点一下右下角的 分享按钮.
2.您的鼓励是博主写作最大的动力，感谢您的分享和赞赏.