使用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应用程序（这似乎是您想要的），这将成为一个问题。 Sphinx apidoc想要一堆目录来扫描python包。