獅身人面像 - 記錄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()