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 的配置!

Github项目文档的管理相关推荐

信息系统项目文档及其管理
信息系统项目文档及其管理信息系统项目相关信息(文档) 配置管理配置管理的概念配置管理的目标和方针日常配置管理活动信息系统项目相关信息(文档) 1.软件文档一般分为三类:开发文档.产品文档.管 ...
如何写一个好的Github项目文档
一.什么是Github? Github是通过Git进行版本控制的软件源代码托管服务平台. Github除了Git代码仓库托管及基本的Web管理界面以外,它还提供了一些方便社会化共同软件开发的功能,即一 ...
PM_14 项目文档管理与配置管理
选择 + 案例 1. 信息系统项目文档及其管理 1.1 信息系统项目相关信息(文档) 1.1.1 软件文档分类(三类) 1.开发文档描述开发过程本身(技术),基本的开发文档包括: (1)可行性研究报告 ...
showDoc项目文档管理工具
ShowDoc是什么每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂.文档呢?!文档呢?!Show me the doc !! 程序员都很希望别人能写技术文档,而自己却 ...
github创建项目_用了 GitHub 上这款开源神器后，创建项目文档变得 so easy！
大家好,我是小 G. 今天跟大家分享一个可用于快速创建项目文档的开源神器:MkDocs. https://github.com/mkdocs/mkdocs 该项目创建自 2014 年,目前 GitHu ...
知识管理≈内容管理≈文档管理≈项目文档管理
事情的起因有点偶然,阿杜和我聊起系统的时候,说我们的系统现在开发的还可以,就畅想了一下能否有一个桌面文档管理系统,问起原因,主要是感觉很多人不会管理自己的硬盘,不会管理自己的文档. 我听了也是感觉一振 ...
项目经理成长之路---PMP、管理知识、项目文档、项目管理软件工具、PPT、WORD
项目经理成长之路---PMP.管理知识.项目文档.项目管理软件工具.PPT.WORD [1]PMP备考资料 | PMP备考九阴真经 --- 项目管理十大知识领域49个过程输入输出.工具与技术暨知识点汇 ...
Mobox项目文档管理-项目经理必备工具
项目文档管理-项目经理必备工具项目文档管理是项目管理中非常重要而基础的一环,存在于项目的整个生命周期之中.如果一个项目缺乏文档管理,那么它也就不是一个规范.标准的项目.文档管理在项目开发中占有十分重 ...
【转】如何更好的进行项目文档管理
如何更好的进行项目文档管理在文档管理的过程中,需要把握住一些重要的原则和方法,这样可以让我们的文档真正达到我们预期的目的. 文档模板的管理面对各类纷繁复杂的文档,如果各式各样,每个人一个风格,不 ...