如何从Django模型生成文档？

Question

目前我们使用Sphinx进行项目文档和Django模型字段描述。

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

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

Answer 1

documentation说：

  

Django的文档使用了Sphinx文档系统   转是基于docutils。基本的想法是轻微格式化   纯文本文档转换为HTML，PDF和任何其他文档   输出格式。

因此，您应该使用sphinx为您的django应用程序生成doc。您应该使用autodoc扩展从sphinx中的docstrings激活提取文档，以激活将其放在conf.py中用于sphinx：

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

Answer 2

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