- 引言
- 本书涉及的内容
- 第 1 部分 Python 开发入门
- 第 1 章 Python 入门
- 第 2 章 开发 Web 应用
- 第 3 章 Python 项目的结构与包的创建
- 第 4 章 面向团队开发的工具
- 第 5 章 项目管理与审查
- 第 6 章 用 Mercurial 管理源码
- 第 7 章 完备文档的基础
- 第 8 章 模块分割设计与单元测试
- 第 9 章 Python 封装及其运用
- 第 10 章 用 Jenkins 持续集成
- 第 11 章 环境搭建与部署的自动化
- 第 12 章 应用的性能改善
- 第 13 章 让测试为我们服务
- 第 14 章 轻松使用 Django
- 第 15 章 方便好用的 Python 模块
- 附录 A VirtualBox 的设置
- 附录 B OS(Ubuntu)的设置
文章来源于网络收集而来,版权归原创者所有,如有侵权请及时联系!
7.5 小结
本章对 什么样的环境便于开发者写文档 进行了整理,并以 Sphinx 为例介绍了实现此类环境的方法。
我们无法保证大程序从一开始就能被正确实现,同样道理,我们也无法保证大文档从一开始就能有一个正确的结构。Sphinx 这类结构便于文档阶段性成长,它能防止我们在写文档上浪费劳动力,同时也能作为指向标,引导我们最终完成一份恰到好处的文档。
另外,对于 写有用的文档 这一无法用工具解决的问题,各位可以运用文档集来弥补。将已有文档的结构和构造升华为文档集来重复利用,不但能逐渐提高文档的品质,还能有效降低文档编写的成本。
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论