Read The Docs文档不更新,重新导入GitHub仓库构建成功仍显示旧版本
可行排查方案
1. 核对版本与默认展示规则
- 进入RTD项目后台的「版本」管理页,确认站点默认展示的版本是否为你正在更新的分支/标签
- 绝大多数这类问题都是因为默认展示的是
stable版本,而stable绑定的是旧的发布Tag,你新提交的内容都推到了latest对应的开发分支,二者没有同步 - 可以直接将默认展示版本切换为
latest,或者给最新代码打符合语义化规则的新Tag,触发stable版本重新构建
2. 验证构建任务的拉取源
- 点开任意一条成功的构建记录,拉到完整日志区域,查找git操作相关的日志
- 确认构建时拉取的分支和提交哈希值,和你Github仓库上最新提交的哈希值完全一致
- 如果日志中显示的提交ID是旧版本,说明RTD侧存在仓库镜像缓存,你可以在项目后台找到「清理」功能,清理缓存后手动触发一次构建
3. 检查本地构建配置与引用关系
- 先在本地执行和RTD一致的构建命令,确认本地生成的HTML文件已经包含你修改的内容,排除本地构建逻辑的问题
- 检查项目根目录下的
.readthedocs.yaml配置,确认build.output_dir指向的是正确的构建产物目录,没有配置错误把旧的构建目录当输出 - 确认你修改的
README.rst已经被文档主索引文件(一般是docs/index.rst)通过include等规则引入,否则修改的内容不会被编译到最终站点中
4. 清理RTD全局CDN缓存
- 排除以上问题后,大概率是RTD的全局CDN还残留旧内容的缓存,默认缓存有效期最长为24小时
- 你可以在项目后台找到「失效CDN缓存」的选项,手动触发缓存失效,等待10到15分钟后再访问站点验证
内容的提问来源于stack exchange,提问作者chasmani
相关产品推荐
相关产品推荐

