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