Django管理文档生成器不格式化模型的Docstrings

Question

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

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

:view:`appname.view_name`

如果插入到视图的docstring中，

将呈现为链接（我想要的），但在插入任何模型的docstring时将以纯文本形式显示为“：view：`appname.view_name`”。但是，当插入模型的方法时，格式化会再次按预期工作。

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

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

编辑：

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

例如

类MyModel（models.Model）：

“”“

标题

“”“

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

Answer 1

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

这已在卡#5405中解决，但仍未在master中合并，因为它创建了一些合并冲突。最后更改：

  

我在拉取请求上留下了评论，但它仍然需要一些改进，包括干净地合并的rebase。提及发行说明中的​​变化也是很好的。