Django 管理文档生成器没有为模型格式化文档字符串

Question

我目前正在使用 Django 管理文档生成器记录我所有的 django 视图和模型。虽然我在记录视图方面没有任何问题，但是在我的模型的文档字符串中编写的任何内容都在文档中呈现为纯文本。

换句话说，如果我想引用一个视图：

:view:`appname.view_name`

如果插入到视图的文档字符串中，将呈现为链接（我想要的），但是当插入到任何模型的文档字符串中时，将以纯文本形式显示为“:view:`appname.view_name`”。但是，当插入模型的方法中时，格式化会再次按预期工作。

起初我认为这是文档生成器的一个怪癖，可能它没有读取模型文档字符串的标记，但在阅读了文档（在此处找到：https://docs.djangoproject.com/en/1.5/ref/contrib/admin/admindocs/#model-reference）之后，您似乎应该能够链接到文档的其他部分。

我没有看到其他人遇到这个问题，我不确定从哪里开始寻找解决方案。提前感谢您提供任何专业知识和解释。

编辑：

似乎在模型的文档字符串中完全跳过了格式 - 即它将忽略重新结构化的文本。

例如

类 MyModel(models.Model)：

"""

标题

"""

将在 django 管理文档中以纯文本形式显示为 Title。

Answer 1

Django 管理文档生成器当前（撰写本文时为 1.7）不支持模型文档字符串中的重构文本。

这已在卡 #5405 中得到解决，但仍未在 master 中合并，因为它会产生一些合并冲突。最后更改：

我在拉取请求上留下了 cmets，但它仍然需要一些改进，包括一个 rebase 以干净地合并。最好在发行说明中提及更改。