如何从Django模型中提取文档?

时间:2013-10-14 08:55:41

标签: python django django-models documentation

我有一个作为django应用程序编写的项目。虽然它处于频繁更改的中间,但客户端坚持在我的项目中更新最新的数据库模型。我必须创建一个libreoffice文档,并使用我的django models.py文件中的最新表/列更改进行更新。它开始变得烦人。

所以我很好奇是否有工具或django应用程序可用于从django模型中提取模型元数据(类文档,help_textField类,关系等)中的信息并创建一个好的文件(TXT / TeX / ODF / PDF等)出来了吗? django已经可以生成SQL命令了,所以我认为它应该是可能的。

有什么建议吗?

我脑海中的文档可能包含用于描述每个数据库表(来自模型类docstring)的段落,以及字段名称及其描述的子弹列表以及可能的数据库属性(被索引,唯一,列类型)

1 个答案:

答案 0 :(得分:2)

pydoc可以从所使用的文档字符串中提供基本文档,但是对于更完整的文档集,您将需要使用Sphinx,它用于创建Python和Django文档网页和下载。