在Github里集成Readthedocs服务
2024-09-01 12:01:08
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中就可以查看文档咯！
最新文章
- jQuery如何退出each循环的？
- IComparable<T> Vs. IComparer<T> System.Comparison<T>
- 【原创】Lucene.Net+盘古分词器(详细介绍)
- BZOJ3734 : [Ontak2013]Miny
- Linux 远程和本地的一些解决方案
- Sublime Text使用教程【转】
- UVA 1599 Ideal Path（bfs1+bfs2，双向bfs）
- MYSQL 查看当前用户与数据库版本
- 湖南省第八届大学生程序设计大赛原题 D - 平方根大搜索 UVA 12505 - Searching in sqrt(n)
- MySQL查看索引、表信息、触发器
- js模块化/js模块加载器/js模块打包器
- 新博客在SEO方面需要注意哪几点？
- win10 UWP 全屏
- Android 模块构建错误不能下载依赖包
- opencv源码学习： getStructuringElement函数;
- 剑指offer错题记录
- 《Linux就该这么学》第五天课程
- Tomcat8源码笔记(三)Catalina加载过程
- CSS之设置滚动条样式
- pytorch 对变长序列的处理