Django 管理文档生成器未格式化模型的文档字符串

1 投票
1 回答
750 浏览
提问于 2025-04-17 21:09

我现在正在用Django的管理文档生成器记录我所有的视图和模型。记录视图的时候没有遇到任何问题,但是我模型里的文档字符串(docstrings)在文档中却只显示为普通文本。

换句话说,如果我想引用一个视图:

:view:`appname.view_name`

在视图的文档字符串中插入后会显示为一个链接(这是我想要的),但如果我把它放到任何模型的文档字符串中,它就会显示为":view:`appname.view_name`"的普通文本。不过,当我把它放到模型的方法里时,格式又能正常显示了。

起初我以为这是文档生成器的一个小问题,可能它不读取模型文档字符串里的标记格式,但在阅读了文档后(可以在这里找到:https://docs.djangoproject.com/en/1.5/ref/contrib/admin/admindocs/#model-reference),似乎我应该能够链接到文档的其他部分。

我没有看到其他人遇到这个问题,也不太确定该从哪里开始寻找解决方案。提前感谢任何专业的建议和解释。

编辑:

看起来模型的文档字符串完全跳过了格式化,也就是说它会忽略reStructured文本。

例如:

class MyModel(models.Model):

"""

标题

"""

在Django管理文档中会简单地显示为标题的普通文本。

1 个回答

1

Django的管理后台文档生成器(在写这段话时是1.7版本)目前不支持在模型的文档字符串中使用reStructuredText格式。

这个问题在卡片#5405中提到过,但由于出现了一些合并冲突,所以还没有合并到主版本中。最近的更新是:

我在这个拉取请求上留下了评论,但仍然需要一些改进,包括重新整理以便能顺利合并。还应该在发布说明中提到这个变化。

撰写回答