用Sphinx写API文档

| 分类 技术随笔  | 标签 技术写作 

相比于给各种产品写说明书,还是写API文档的技术性更强一点。

给Python的类、函数等写说明,可以使用docstring写在代码里,然后使用sphinx自动生成。

具体教程托管在readthedocs上:https://sphinx-apidoc.readthedocs.io/zh_CN/latest/

用于生成API的文档的方案总结 讲的,生成REST API用swagger更好些,国内的阿里有开源rap这一工具。

技术文档写作者Tom Johnson的网站有API文档写作更详细的教程:http://idratherbewriting.com/learnapidoc/


上一篇     下一篇