知识卡片
文档发布应追溯到对应源码
源文档已更新不代表读者正在看的生成站点同步更新;可将构建和静态发布纳入持续交付,让页面对应明确修订与适用软件版本。make html只是教材构建入口,成功构建不证明叙述和链接都对。Read the Docs是原书托管例,免费政策、集成范围与实际配置应另查,不用历史点击步骤作现行保证。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 第9章 文档化你的项目 9.4.2 文档构建与持续集成 · 查看原书依据
不能保证文档读者能够访问最新的编译版本
参考来源
- 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元020;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。
- 结论依据:原文指出源更新与读者可访问编译版可能不同步,直接支持发布产物绑定修订;make成功也未检查叙述或所有链接准确。未在本机运行示例或改变环境。
- 原始内容:文档的源版本与其文档中的代码相匹配,但并不能保证文档读者能够访问最新的编译版本。 如果文档的目标读者不够熟练地使用命令行工具,并且不知道如何将其构建为可浏览和可读的形式,则仅具有最小的源表示也是不够的。当提交/推送任何更改到代码仓库时,自动将你的文