Python 如何从Django模型生成文档?

Python 如何从Django模型生成文档?,python,django,Python,Django,目前,我们用于项目文档和Django模型字段描述 主要问题是:在更改模型后,我们手动更新了Sphinx文档,有时会忘记/遗漏文档中的某些字段 是否有基于Django模型生成文档的工具?说明: Django的文档使用Sphinx文档系统,它在 turn是基于docutils的。其基本思想是轻松格式化 纯文本文档转换为HTML、PDF和任何其他格式 输出格式 因此,您应该使用sphinx为django应用程序生成文档。您应该使用autodoc扩展从sphinx中的docstrings中激活提取文档,

目前,我们用于项目文档和Django模型字段描述

主要问题是:在更改模型后,我们手动更新了Sphinx文档,有时会忘记/遗漏文档中的某些字段

是否有基于Django模型生成文档的工具?

说明:

Django的文档使用Sphinx文档系统,它在 turn是基于docutils的。其基本思想是轻松格式化 纯文本文档转换为HTML、PDF和任何其他格式 输出格式

因此,您应该使用sphinx为django应用程序生成文档。您应该使用autodoc扩展从sphinx中的docstrings中激活提取文档,要激活,请将其放入sphinx的
conf.py

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

为Django生成文档的最佳方法-使用admindocs

可以基于
verbose\u name
?@A.Innokentiev生成字段文档。这不是默认值吗?我没有使用sphinx,但我见过一些非常好的标准Django行为,这些行为与
verbose\u name
或(可能更接近您所期望的)
help\u text
@mariusiuram有关,我正在寻找一个工具,它可以基于Django模型生成文档(面向前端开发人员)。我想要一些这样的功能:如果我们添加/删除一些模型字段或编辑
详细名称
-文档会自动更新。如何生成包含该
/admin/doc/
所有页面的全包PDF?