如何從Django模型生成文檔？

Question

目前，我們將Sphinx用於項目文檔和Django模型字段描述。

主要問題是：更改模型后，我們手動更新了Sphinx文檔，有時會忘記/錯過文檔中的某些字段。

有一些用於基於Django模型生成文檔的工具嗎？

Answer 1

該文件說：

Django的文檔使用Sphinx文檔系統，該系統又基於docutils。 基本思想是將格式簡單的純文本文檔轉換為HTML，PDF和任何其他輸出格式。

因此，您應該只使用sphinx為django應用程序生成文檔。 您應該使用autodoc擴展名激活從sphinx中的文檔字符串中提取文檔，以激活將其放入conf.py以獲取sphinx：

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

Answer 2

為Django生成文檔的最佳方法-使用admindocs 應用 。