django - Tastypie 文档生成

Question

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

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

Answer 1

您可能想看一下sweetpie-swagger，它使用Swagger为您的Tastypie API 生成 /doc/ 页面。

经过一些小的调整（我想这是由于美味派版本的差异，这是必要的），我已经取得了一些成功。

编辑：我认为必要的改编（由于 django 版本 < 1.4 和 sweetpie 版本 > 0.9.11）现在合并到了 sweetpie-swagger 的主线分支中。

Answer 2

还有Django Tasty Docs，它是Tasty Tools的一部分

Answer 3

也许我完全错过了您的问题的重点，但是如果您只是尝试构建源代码分发附带的文档，那么 docs 目录中有一个 Makefile 可以执行必要的操作。您需要指定目标输出类型，例如 html、json、latex 等。我保留了 django、tastepie 和 slumber 文档的本地副本，因为我将这三者结合使用，并且我make html经常使用该选项.

如果我对您要完成的工作有误，也许我们可以澄清一下。