Tastypie文档生成

Question

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

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

Answer 1

您可能想看看tastypie-swagger，它使用Swagger为您的Tastypie应用编程接口生成一个/doc/页面。

经过几次小的改编，我已经取得了一些成功(我想，这是由于口味不同而有必要的)。

编辑：我发现有必要的修改(由于django版本< 1.4，tastypie版本> 0.9.11)现在被合并到tastypie swagger的主线分支中。

Answer 2

还有Tasty Tools的一部分Django Tasty Docs

Answer 3

也许我完全没有抓住你问题的重点，但是如果你只是想构建源码发行版附带的文档，那么在docs目录中有一个Makefile来执行必要的操作。您需要指定一个目标输出类型，例如html、json、latex等。我为django、tastypie和slumber保留了一个文档的本地副本，因为我将所有这三种类型结合使用，并且我经常使用选项make html。

如果我搞错了你想要实现的目标，也许我们可以澄清一下。