Github项目文档的管理

1. 用github账号注册readthedocs

readthedocs 官网

2. 安装Sphinx包

（1）

pip install sphinx

（2）准备文档

cd /path/to/project
mkdir docs

（3）运行

cd docs
sphinx-quickstart

（4）制作网页

make html

index.rst 转成 index.html

具体参考：

readthedocs sphinx

3. 把文档上传到GitHub

4. readthedocs关联GitHub的项目

readthedocs dashboard

5. readthedocs编译

6. 添加文档主题（可选）

为了让文档更好看，可以选择一些主题，比如：

https://github.com/readthedocs/sphinx_rtd_theme

效果展现

完成！

更多细节可以查看 Github semisupervised 的配置!