我目前正在使用Django管理文档生成器记录我所有的django视图和模型。尽管我在所有文档视图中都没有遇到任何问题,但是,在我的模型的文档字符串中编写的任何内容都在文档中以明文形式呈现。Django管理文档生成器不格式化文件的型号
换句话说,如果我想引用一个观点:
:view:`appname.view_name`
将呈现为一个链接(我想)如果插入到视图中的文档字符串,但将显示为“:当插入到任何模型的文档字符串中时,以明文形式显示“appname.view_name`”。但是,插入到模型的方法中时,格式将按预期工作。
起初我以为这是文档生成器的一个怪癖,也许它不会读取模型文档字符串的标记,但在阅读文档(在此处找到:https://docs.djangoproject.com/en/1.5/ref/contrib/admin/admindocs/#model-reference)之后,似乎您应该可以链接到文档的其他部分。
我还没有看到任何其他人有这个问题,我不知道从哪里开始寻找解决方案。预先感谢您的任何专业知识和解释。
编辑:
好像格式化主要模式的文档字符串完全忽略 - 也就是说,它会忽略修改案文。
例如
类为MyModel(models.Model):
“” “
标题
”“”
将简单地显示为标题django admin docs中的明文中的。
问题用附加信息更新。如果这在下一个补丁中出现,那将会很好。 – starr749
@ starr749虽然看起来并不太乐观,但根据机票上的日期。我也很失望,有参数的模型方法没有得到记录 – zanderle
更新:这将得到补丁1.8 – zanderle