Django管理文档生成在格式化文档字符串模式(Django admin documentation

我目前在记录所有的使用Django管理文档生成我Django的视图和模型的过程。 虽然我还没有在所有记录视图中的任何问题，但是任何事情写在我的模型的文档字符串被渲染，就像在文件中明文。

换句话说，如果我想引用一个观点：

:view:`appname.view_name`

将呈现为一个链接（我想）如果插入到视图中的文档字符串，但会显示为当插入任何型号的文档字符串中明文“：`appname.view_name`：观”。 然而，当插入模型的方法，格式作品再次预期。

起初我以为这是文档生成的怪癖，也许它不会读取模式文档字符串的标记，但在这里阅读文档（后发现： https://docs.djangoproject.com/en/1.5/ref /的contrib /管理/ admindocs /＃模型参考 ）你好像我应该能够链接到文件的其他部分。

我还没有看到任何人有这个问题，我不知道从哪里开始寻找一个解决方案。 感谢您的任何专业知识和解释。

编辑：

这似乎是格式化的型号的文档字符串完全忽略 - 也就是说，它会忽略修改案文。

例如

类为MyModel（models.Model）：

“””

标题

“””

将简单地显示为在Django管理员文档标题中明文。

Answer 1:

目前Django管理文件生成器（1.7在写作时）不支持在模型文档字符串重组文本。

这是在卡解决＃5405 ，但仍然没有在主被合并，因为它创造了一些合并冲突。 最后一次变更：

我留在拉入请求意见，但它仍然需要一些改进，包括一个重订干净合并。 这也将是很好的提发行说明的变化。

文章来源: Django admin documentation generator not formatting Docstrings for Models