Tastypie文档生成

Jas*_* Xu 14 django documentation python-sphinx tastypie

我正在尝试使用auto-doc工具为tastypie REST API生成API文档.我尝试过Tastytool,但似乎没有显示api的结果参数,而是模型的列.然后我尝试Sphinx似乎更有前途,因为Tastypie支持Sphinx,但我找不到一个示例来显示在代码中为API放置注释的位置和方式,并将它们生成到文档中.

任何人都可以分享一些有关正确撰写评论的信息或示例,并为基于Tastypie的API生成Sphinx文档?谢谢.

tcm*_*cmb 13

您可能想看一下tastypie-swagger,它使用Swagger为您的Tastypie API 生成/ doc /页面.

经过一些小的修改后,我已经取得了一些成功(由于tastypie版本的差异,我认为这是必要的).

编辑:我发现必要的改编(由于django版本<1.4和tastypie版本> 0.9.11)现在合并到tastypie-swagger的主线分支.