执行摘要
- 一句话:修复 RTD 文档构建因 PyTorch URL 失效
- 推荐动作:可精读但不必要:变更简单直接,TODO 注释清晰。 值得关注的是上游 PyTorch issue #182007 的修复进展,以便及时恢复 URL。
功能与动机
自 2026-04-29 23:09 UTC 起,PyTorch 文档仓库的 pytorch/docs PR #84 将 stable/ 下的符号链接替换为逐页 HTML 重定向存根,未同步非 HTML 构建产物(包括 objects.inv、searchindex.js 等),导致 https://pytorch.org/docs/stable/objects.inv 返回 404,进而使 vLLM 的 ReadTheDocs 构建全部中断。
实现拆解
修改 mkdocs.yaml 中 PyTorch 交叉引用清单的 URL:
- 将
https://pytorch.org/docs/stable/objects.inv 替换为 https://pytorch.org/docs/2.11/objects.inv
- 添加
# TODO 注释,引用上游 PyTorch issue #182007,提示在问题解决后恢复为 /stable/
关键文件:
mkdocs.yaml(模块 文档配置;类别 config;类型 configuration): 唯一变更文件,修改 PyTorch 交叉引用清单 URL 以修复 RTD 构建。
关键符号:未识别
评论区精华
审阅者 hmellor 在评论中建议添加 TODO 注释并修改 URL,贡献者 stecasta 接受建议。 hmellor 最终审批通过,表示“Good catch, thanks for the quick fix!”。
- 添加 TODO 注释以跟踪上游修复 (question): 贡献者接受建议,在提交 595ac2e 中应用了该建议。
风险与影响
- 风险:风险极低:这是一次简单的配置 URL 变更,仅影响文档构建阶段的交叉引用解析。 当 PyTorch 发布 2.12 或上游修复
/stable/ 后需要手动升级 URL,但已有 TODO 注释提示。
- 影响:影响范围:仅影响 ReadTheDocs 文档构建流程。 恢复到正常构建,无功能变更。 对用户无直接影响,但 API 文档可正常生成。
- 风险标记:外部依赖变更, 配置修复
关联脉络
参与讨论