Django Tastypie文档生成

Django Tastypie文档生成,django,python-sphinx,tastypie,documentation-generation,Django,Python Sphinx,Tastypie,Documentation Generation,我正在尝试使用自动文档工具为TastypieRESTAPI生成API文档。我尝试了Tastytool,但它似乎没有显示API的结果参数,而是显示模型的列。然后我尝试了Sphinx,因为Tastypie支持Sphinx,所以它看起来更有希望,但是我找不到一个例子来说明如何在代码中为API添加注释,并将它们生成到文档中 任何人都可以分享一些关于为基于Tastypie的API正确编写注释和生成Sphinx文档的信息或示例?谢谢。也许我完全没有抓住你问题的重点,但是如果你只是想构建源发行版附带的文档,那

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


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

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


如果我误解了您试图实现的目标,也许我们可以进行一些澄清。

您可能想看看,它用于为您的API生成/doc/页面

经过一些小的修改(我想这是由于Tastype版本的不同而必需的),我在这方面取得了一些成功


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

还有一部分是很抱歉没有澄清我的问题。我可以使用Sphinx内置命令行生成文档,但我找不到正确的位置和格式,无法在代码中为每个API添加注释并将其生成文档。因此,您是否正在尝试为自己的API类编写Sphinx文档,这些API类利用Tastypie?为了便于安装,它似乎不在pip索引中:(tastypie swagger不支持最新的django版本。有没有克服这个障碍的想法?谢谢