Django:从模型管理到文档的超链接

Question

我有一个广泛使用 django 管理界面的应用程序。

管理 GUI 中的某些内容需要解释(域/模型特定文档)。

我们使用 sphinx，屏幕截图可以解释详细信息。

是否有一种通用/自动化的方法来创建从模型实例的 django 管理界面到文档中的匹配部分的超链接？

我知道我可以更改模型的管理模板，但不知何故，我想有人有更好的想法如何以更专业的方式解决这个问题。

就我而言，文档托管在同一服务器上。据我所知，如果您有一个远大的梦想，即也有从文档到 django 应用程序的链接(但这是一个不同的问题)，那么这是需要的。

“文档中的匹配部分”是什么意思？

假设我有一个名为“Foo”的模型。

我有模型的文档(包括图像)。

现在我想要一个从模型管理页面到模型“Foo”文档的超链接。

我认为这是一个非常普遍的问题。我觉得很遗憾的是框架和第三方应用程序都没有帮助编写集成文档。

Answer 1

这是我在管理站点中为特定模型创建链接的方法。

class YourModelAdmin(admin.ModelAdmin):

    def link_to_doc(self,obj):
        link = 'https://www.stackoverflow.com'
        return u'<a href="%s">%s</a>' % (link, "Link Name")

    link_to_doc.allow_tags = True
    link_to_doc.short_description = "Link Description for admin"

    fields = (
         'your_model_fields',
         'link_to_doc'           
    )

    readonly_fields = (
         'your_model_readonly_fields',
         'link_to_doc'           
    )


admin.site.register(YourModel, YourModelAdmin)