readthedocs 与 gitee 集成 webhooks

最新推荐文章于 2025-06-10 14:30:59 发布

icbm

最新推荐文章于 2025-06-10 14:30:59 发布

阅读量1.1k

点赞数

CC 4.0 BY-SA版权

分类专栏： asciidoc docs

本文链接：https://blog.youkuaiyun.com/icbm/article/details/81265908

5 篇文章

订阅专栏

2 篇文章

订阅专栏

本文介绍如何解决Gitee与Readthedocs集成时Webhook格式不匹配的问题，并提供了一个手动触发文档构建的解决方案。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

因为 gitee 的 webhook 请求发送的格式与 readthedocs 所需要求的格式不匹配，因此下面文章中的操作步骤不再可用。

经查阅 readthedocs 官方文档，可以手工发送 webhook 请求，经测试可用，格式如下：

curl -X POST -d "branches=dev" -d "token=1234" https://readthedocs.org/api/v2/webhook/example-project/1/

下文已失效，请勿参考

在 gitee 上托管 readthedocs 上文档的源代码。当源代码更新后，通过 webhooks 通知 readthedocs 重新构建文档，使文档始终保持更新。

在 readthedocs 项目的主页上，点击“ Admin ”：

这里写图片描述

在左边的菜单列表中，选择“ Integration ”：

这里写图片描述

点击右边的“ Add Integration ”按钮：

这里写图片描述

在“ Integration ”下拉列表框中，选择“ Generic API Incoming webhook ”：

这里写图片描述

在结果页面中，记录下 webhook 的 URL ，如下图红色框中内容所示。该 URL 将用在 gitee 中，详见后续步骤说明。

这里写图片描述

在代码库主页点“ 管理 ”，在左边菜单列表选“WebHooks”，在右边的“WebHooks设置”窗口点“添加”按钮：

这里写图片描述

在弹出的“ 添加 Web Hooks ”窗口中，将 readthedocs 中记录 webhook 的 URL ，填写入 URL 文本框。注意： URL 以 https:// 开头。
仅需要选中“PUSH” 事件选项。点击“提交”，设置完成。

这里写图片描述

最后，在“WebHook 设置”窗口，点击刚添加的webhook 的“测试”按钮，测试 webhook 是否生效。