python - 在管理应用程序中显示模型的文档字符串

Question

在 Django 管理中，显示各个字段的 help_text 属性以提供说明。但是，我想为整个模型添加一个类似的功能。

在代码中，我使用文档字符串来保存关于模型的一般说明，如果我可以在 Django 管理中显示它，它将非常有用。完美的方法是在索引页面上使用模型文档字符串的第一行，并在列表和表单页面上使用全部内容。

是否有任何模块/片段可以解决这个问题，还是我应该自己编写？ ;.)

Answer 1

不是您描述的“完美方式”，但有 django.contrib.admindocs

对于“完美方式”，您可以制作一个返回模型文档字符串的小模板过滤器，并在您的重载或 admin/change_form.html 和 admin/change_list.html 中使用它。

如果我错了请纠正我，但文档字符串不是应该本地化内容的理想场所。

如果每个模型要本地化的文本量很短，例如一两个句子，请考虑以下几点:

• 少量文本可以保存在 python 变量中。
• Python 变量可以由 django.utils.translation.ugettext 代理。
• 一个类可以包含一个 python 变量。

所以我会尝试类似的方法:

from django.utils.translation import ugettext as _

class Foo(models.Model):
    help_text = _(u'Documentation of Foo model to localize')