如何才能写出简洁好看的API文档,有没有开源框架可以用

 我来答
爱染年
2016-12-25 · 知道合伙人互联网行家
爱染年
知道合伙人互联网行家
采纳数:4753 获赞数:7830
国家励志奖学金获得者

向TA提问 私信TA
展开全部
你需要Sphinx!!!
Python的官方文档就是用这个写的。不过注意这个Sphinx是一个文档编写工具而不是那个有名的全文检索引擎。
Sphinx使用reStructuredText 标记语法(和其他一些语法)来提供文档控制。reStructuredText 和Markdown类似,但是功能更为强大。
更为方便的是,网上有一个网站提供rst的在线编辑器,地址为http://rst.ninjs.org/,你可以像使用编辑器一样来编写你的API文档,然后复制到Sphinx项目中去就行了。
最后make html一下就生成了静态网页的文档,还能选择或者自定义模板。
推荐律师服务: 若未解决您的问题,请您详细描述您的问题,通过百度律临进行免费专业咨询

为你推荐:

下载百度知道APP,抢鲜体验
使用百度知道APP,立即抢鲜体验。你的手机镜头里或许有别人想知道的答案。
扫描二维码下载
×

类别

我们会通过消息、邮箱等方式尽快将举报结果通知您。

说明

0/200

提交
取消

辅 助

模 式