Tastypie文档生成

Question

我正在尝试使用自动文档工具为tastypie REST API生成API文档。我尝试过Tastytool，但似乎没有显示api的结果参数，而是模型的列。然后我试过Sphinx看起来更有希望，因为Tastypie支持Sphinx，但我找不到一个例子来显示哪里＆amp;如何在代码中放置API的注释，并将它们生成到文档中。

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

Answer 1

您可能需要查看tastypie-swagger，Swagger使用Tastypie为您的{{3}} API生成/ doc /页。

经过一些小的调整后我已经取得了一些成功（由于tastypie版本差异，我认为这是必要的）。

编辑：我发现必要的修改（由于django版本＆lt; 1.4和tastypie版本＆gt; 0.9.11）现在已合并到tastypie-swagger的主线分支中。

Answer 2

Django Tasty Docs

也是Tasty Tools的一部分

Answer 3

也许我完全忽略了你的问题，但如果你只是想构建源代码发行版附带的文档，那么docs目录中会有一个执行必要操作的Makefile。您需要指定目标输出类型，例如html，json，latex等。我保留django，tastypie和slumber的文档的本地副本，因为我将所有三个相互结合使用，我使用选项{经常{1}}。

如果我误解了你想要完成的事情，也许我们可以澄清一下。