Tastypie 文档生成 [关闭]答案

【问题标题】：Tastypie documentation generation [closed]Tastypie 文档生成 [关闭]
【发布时间】：2012-10-02 20:18:08
【问题描述】：

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

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

【问题讨论】：

标签： django python-sphinx tastypie documentation-generation

【解决方案1】：

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

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

【讨论】：

很抱歉没有澄清我的问题。我可以使用内置命令行的 Sphinx 生成文档，但我找不到正确的位置和格式来将我对代码中每个 API 的注释放入文档中。
那么您是否正在尝试为您自己的利用 Tastypie 的 API 类编写 sphinx 文档？

【解决方案2】：

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

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

编辑：我认为必要的调整（由于 django 版本 0.9.11）现在合并到了 tastepie-swagger 的主线分支中。

【讨论】：

tastypie-swagger 不支持最新的 django 版本。关于克服这个障碍的任何想法？谢谢

【解决方案3】：

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

【讨论】：

这似乎不在 pip 索引上以便于安装:(