狮身人面像 - 记录Django模型

Question

我使用狮身人面像为了文档我有一个Django应用程序。

当自动生成文档时，我希望Sphinx在文档中添加每个模块的字段。

狮身人面像完全跳过这些。事实上，没有任何领域的痕迹。

任何想法？

詹姆斯

Answer 1

您在模型的文档字符串使用

@param description 

，每场要由狮身人面像被记录在案。

或者在替代，你应该看看这个snippet，你想要做什么（减去无聊的写作部分）

[编辑]

如果你打算使用这个片段中，在Django> = 1.6

obj._meta._fields() 

已被删除，请其更改为

_meta.fields 

Answer 2

如果你打算使用这个snippet，在Django 1.7+：

1. 你必须设置您的Django项目 django.setup()
2. 使用 obj._meta.get_fields() 代替： obj._meta._fields()