使用Sphinx自动化Django文档

Question

我使用Sphinx为Django项目生成文档，并且它运行得非常好。但是，似乎有必要自己编写.rst文件，一旦完成，sphinx将在运行make HTML时从文档字符串中编译文档。

我的问题是： 我正在寻找文档以自动反映项目的新增内容，而无需手动编辑.rst文件。

由于Django中的所有东西看起来总是如此简单，所以我觉得奇怪的是你必须手动为整个项目创建第一个文件，我会认为有一些已经存在的东西会自动检查项目，并从中建立第一个。

我看过这个项目http://pypi.python.org/pypi/django-sphinx-autodoc/0.0看起来很有前途，但我很惊讶没有更成熟的东西。

Answer 1

一段时间后，Sphinx apidoc与Sphinx捆绑在一起。这可以为您创建一整套.rst文件。

如果您想记录您在一个站点中使用的所有各种django应用程序（这似乎是您想要的），它就成了一个更大的问题。狮身人面像apidoc希望一堆目录扫描python软件包。