django - 使用 Sphinx 自动化 Django 文档

Question

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

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

由于 Django 中的一切看起来总是那么简单，我觉得很奇怪你必须手动为整个项目创建第一个文件，我原以为已经存在一些东西，它会自动检查项目的结构并构建第一个来自那个。

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

score 1 · Accepted Answer

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

如果您想记录您在一个站点中使用的所有各种 django 应用程序（这似乎是您想要的），这将成为一个更大的问题。Sphinx apidoc 需要一堆目录来扫描 python 包。

1 回答 1