如何更新ReadTheDocs项目名称与URL并保留构建历史
如何在ReadTheDocs上修改项目URL并保留构建历史
- 进入项目管理后台:在RTD的项目仪表盘找到你的项目,点击右上角的「Admin」按钮进入管理界面。
- 修改项目Slug:在Admin菜单里选择「Settings」,找到「Project URL」区域的「Slug」字段——这个字段就是URL中子域名的核心部分(原
oldproject就是旧Slug)。将其修改为newproject后保存设置。 - 验证效果:修改完成后,原URL
oldproject.readthedocs.io会自动跳转至新URLnewproject.readthedocs.io,所有过往的文档构建版本、历史记录都会完整保留在新地址下,无需重新构建旧版本。
额外注意:
- 记得同步更新Python包文档配置(比如
docs/conf.py里的项目名称参数),避免后续构建时出现名称不一致的问题。 - 虽然RTD会自动处理旧URL的跳转,但如果有外部链接指向旧地址,建议逐步更新为新URL。
内容的提问来源于stack exchange,提问作者Ryan
相关产品推荐
相关产品推荐

