使用sphinx快速生成Python API 文档

个人博客导航页（点击右侧链接即可打开个人博客）：大牛带你入门技术栈 

不管是开源还是闭源，文档都是很重要的。当然理论上说，最好的文档就是代码本身，但是要让所有人都能读懂你的代码这太难了。所以我们要写文档。大部分情况，我们不希望维护一份代码再加上一份文档，这样做很容易造成文档和代码的不一致，程序员最讨厌更新文档了。所以最佳实践就是在程序员代码中加注释，然后通过构建脚本自通生成文档。

对应于Pyhon，有很多可供选择的工具：

• sphinx 中文版介绍 Sphinx使用 reStructuredText作为标记语言（类似Markdown），可扩展，功能强大。要注意的是何有一个开源的搜索也叫Sphinx，斯芬克斯果然太受欢迎，开源的世界起个名字不容易呀。

• pdoc 是一个简单易用的命令行工具，可以生成Python的API文档

• Doxygen 是老牌的文档生成工具，可以针对各种语言生成