使用 Sphinx 为项目自动生成 API 文档

对于一个优秀的开源项目，高质量的文档与代码同样重要，糟糕的文档会将大部分潜在用户拒之门外。 从流行的开源项目中，我们可以总结出一些关于文档的最佳实践： 文档和代码库在一个仓库中维护以做到同步更新（个别体量超大的项目例外） 使用纯文本格式编写文档，如 markdown 或 reStructText，然后通过生成工具将其转换成易于阅读且样式丰富的静态网页，进一步可通过 CI...