码迷,mamicode.com
首页 > 其他好文 > 详细

在Github里集成Readthedocs服务

时间:2017-08-15 23:07:29      阅读:198      评论:0      收藏:0      [点我收藏+]

标签:strong   hook   专用   services   htm   排版   托管   bho   文档   

 

Readthedocs支持Markdown格式和sphinx格式的文档排版,是部署项目文档的绝佳平台。利用Github的托管服务,我们可以方便地将文档托管于Github,并利用Readthedocs查阅。

 

1. 在Readthedocs上新建一个项目,在项目中的:管理 -> Integrations -> 添加Github incoming webhook,记下webhook链接地址,待会儿要用;

2. 在Github上新建一个项目,在项目中的:Setting -> Webhooks中添加上面的webhook,用于文档之间的链接;在Setting -> Integrations & Services中添加Services,选择添加“ReadTheDocs”。

 

至此,Github与Readthedocs之间的绑定完成,接下来上传文档。

 

3. 在Github项目中新建一个doc文件夹专用于放文档文件。然后利用python的sphinx库新建文档(http://jwch.sdut.edu.cn/book/tool/UseSphinx.html)。

4. 编译文档。然后文档项目中的source文件夹中的所有文件全部传到Github项目中的doc文件夹中,并远程同步。Done!

 

至此,在Readthedocs中就可以查看文档咯!

在Github里集成Readthedocs服务

标签:strong   hook   专用   services   htm   排版   托管   bho   文档   

原文地址:http://www.cnblogs.com/shixiangwan/p/7367997.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!