如何从Django模型生成文档？

Question

目前我们在项目文档和Django模型字段描述方面使用 Sphinx 。

主要问题在于：在更改模型后，我们需要手动更新Sphinx文档，并且有时会忘记或遗漏某些字段。

是否存在一些基于Django模型生成文档的工具？

- A. Innokentiev

Answer 1

生成Django文档的最佳方式 - 使用admindocs 应用程序。

- A. Innokentiev

---

我该如何生成一个包含/admin/doc/所有页面的全面PDF？ - Csaba Toth

https://docs.djangoproject.com/en/3.1/ref/contrib/admin/admindocs/ - Morten Engelsmann

Answer 2

文档中提到：

Django的文档使用Sphinx文档系统，该系统基于docutils。基本思路是将轻度格式化的纯文本文档转换为HTML、PDF和任何其他输出格式。

因此，您应该使用sphinx为您的Django应用程序生成文档。您应该激活使用autodoc扩展从docstrings中提取文档的功能，在sphinx的conf.py中激活此功能：

extensions = [
    'sphinx.ext.autodoc',
]

- Sebastian Wozny

---

是否可以根据“verbose_name”生成字段文档？ - A. Innokentiev

@A.Innokentiev 这不是默认的吗？我没有使用过 Sphinx，但我已经看到了一些非常好的标准 Django 行为，与 verbose_name 相关或者（也许更接近您的期望）help_text。 - MariusSiuram

@MariusSiuram 我正在寻找一种工具，可以基于Django模型生成文档（供前端开发人员使用）。我希望实现以下功能：如果我们添加/删除某些模型字段或编辑“verbose_name” - 文档将自动更新。 - A. Innokentiev