在Github里集成Readthedocs服务

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中就可以查看文档咯!

时间: 2024-08-08 21:54:33

在Github里集成Readthedocs服务的相关文章

【.NET Core项目实战-统一认证平台】第十六章 网关篇-Ocelot集成RPC服务

原文:[.NET Core项目实战-统一认证平台]第十六章 网关篇-Ocelot集成RPC服务 [.NET Core项目实战-统一认证平台]开篇及目录索引 一.什么是RPC RPC是"远程调用(Remote Procedure Call)"的一个名称的缩写,并不是任何规范化的协议,也不是大众都认知的协议标准,我们更多时候使用时都是创建的自定义化(例如Socket,Netty)的消息方式进行调用,相比http协议,我们省掉了不少http中无用的消息内容.因此很多系统内部调用仍然采用自定义

Redola.Rpc 集成 Consul 服务发现

Redola.Rpc 解决了什么问题? Redola.Rpc 是一个使用 C# 开发的 RPC 框架,代码开源在 GitHub 上.目前版本仅支持 .NET Framework 4.6 以上版本,未来待系统稳健后再考虑移植 .NET Standard 和 .NET Core. Redola.Rpc 在 0.3.2 版本中,尝试解决几个 RPC 设计问题: 我是谁?(Local Actor) 如何告诉别人我是谁?(Actor Directory) 我提供什么服务?(Service Catalog

asp.net中关于Microsoft 信息完整性、隐私性等集成信息安全服务服务 integrated security=SSPI

string [email protected]"server=(local)\SQLExpress;database=AdventureWorks;integrated security=SSPI";中的 integrated security=SSPI   安全支持提供器接口是定义食物比较全面的公用API,用来验证.Microsoft信息完整性.信息隐私等集成安全服务,以及用于所有分布式应用程序协议的安全方面的服务.应用程序协议的设计者能够利用该接口获得不同的安全性服务而不必修改协

如何通过 AAR 形式集成 leakcanary-android 服务

如何通过 AAR 形式集成 leakcanary-android 服务 如何通过在线引用的方式拿到所有相关的依赖项文件? #1.禁用 Gradle 离线模式 #2.按照文档要求添加项目依赖 #3.Sync同步后会在线解析并缓存所有相关依赖项 #4.从依赖项缓存所在目录里找到 *.pom 文件分析其子依赖项 #5.将所有依赖项复制出来. #6.改造 .aar 依赖项文件 #7.修改原在线形式的项目依赖为AAR形式的依赖 #8.启用 Gradle离线模式即可正常使用了. 如何改造 Release 依

jenkins+github持续集成中的坑

1.前言 刚开始开发自己的独立博客的时候,每次发布都要手动打包,上传服务器,杀tomcat进程,重启,来回这么重复性工作,很快就有点不耐烦了.如果能自动化的东西,就绝不要手动了,所以自己搭建了个持续集成环境,配好了结合github进行push时自动构建,自动发布的流程,提交代码,泡杯咖啡就发布好了.本以为很简单,但没想到中间细节还是有不少坑,查了很多资料,墙都翻了好几次,把遇到的问题记录在这里. 2.正文 详细安装教程就不复制粘贴了,推荐此文手把手教你搭建Jenkins+Github持续集成环境

在docker里部署网络服务

之前试着玩玩docker有一阵子了,今天算是头一回正式在docker里部署网络服务. 本来想和lxc差不多的东西那自然是手到擒来,没想到还是改了很多. 第一个遇到的问题是,远程连到docker宿主机干活的时候突然断网了.一下傻掉了,以前都是连内网,从来不断的.这次连了一个反向隧道,居然断了,傻眼了. 再连回去,发现docker ps里还有进程,好办,docker attach这个进程,就又进去了. 如果没有找到进程,就只要docker commit存一下,然后再docker run拉起来继续 如

在openwrt路由中加入n2n,并在ubuntu里加入n2n服务,实现开机联网互通互访

在openwrt路由中加入n2n,并在ubuntu里加入n2n服务,实现开机联网互通互访 1.openwrt的硬件环境: 将自己的WR703N刷入openwrt(这里需要修改FLASH芯片,换个8M的FLASH): 刷机后,安装openwrt,此教程网上一大堆,无需说明了,TELNET进入,并开启SSH后,root登陆. 2.安装n2n到openwrt中: [email protected]:~# opkg update <-----如果不能升级,请运行下条命令,查看源是否正确: [email 

集成Dubbo服务(Spring)

Dubbo是什么? Dubbo是阿里巴巴SOA服务化治理方案的核心框架,每天为2,000+个服务提供3,000,000,000+次访问量支持,并被广泛应用于阿里巴巴集团的各成员站点. Dubbo[]是一个分布式服务框架,致力于提供高性能和透明化的RPC远程服务调用方案,以及SOA服务治理方案. 其核心部分包含: 远程通讯: 提供对多种基于长连接的NIO框架抽象封装,包括多种线程模型,序列化,以及“请求-响应”模式的信息交换方式. 集群容错: 提供基于接口方法的透明远程过程调用,包括多协议支持,以

Jenkins+Github持续集成

由于最近团队代码库从coding迁移到github,在CI工具的选型上尝试了travis-ci和circle-ci,最后决定自己搭建CI服务器,而我也有幸认领了这个任务的调研,因此有了这篇文章. 之前写过一篇文章浅谈Jenkins+Node.js持续集成,那真的是浅谈,Jenkins包含的东西实在太多了,作为从hudson分支出来的开源免费的版本,插件与hudson通用,有更快的迭代速度和稳定性. 为什么选择Jenkins 答案简单:因为免费,学习资料多. 开始吧 安装配置这里就不赘述了,移步浅