admindocs links are not generated on Views documentation

[Lucas Brandstätter]

When I use the admindocs app to generate a documentation on a view the special markup such as

class MyModelFormView(FormView)
"""
This is a form view for :model:`core.Model`
"""

do not generate any links to the core.Model documentation.

When I use the same markup in a model docstring they work as expected an generate a link to the corresponding model.

[Lucas Brandstätter]

Just realized that this only applies to the first line of the docstring

"""
This is a form view for :model:`core.Model` <- Does not generate a link

In this view a :model:`core.Model` is modified <- Generates a link
"""

[Sarah Boyce]

Thank you for the report!
Replicated, here is an example testcase:

tests/admin_docs/test_views.py

@@ -89 +89 @@
         # View docstring
         self.assertContains(response, "Base view for admindocs views.")
 
+    def testview_docstring_links(self):
+        summary = (
+            '<h2 class="subhead"><p>This is a view for '
+            '<a class="reference external" href="/admindocs/models/myapp.company/">'
+            "myapp.Company</a></p></h2>"
+        )
+        url = reverse(
+            "django-admindocs-views-detail", args=["admin_docs.views.CompanyView"]
+        )
+        response = self.client.get(url)
+        self.assertContains(response, summary, html=True)
+
     @override_settings(ROOT_URLCONF="admin_docs.namespace_urls")
     def test_namespaced_view_detail(self):
         url = reverse(

tests/admin_docs/urls.py

@@ -14 +14 @@
     path("admin/", admin.site.urls),
     path("admindocs/", include("django.contrib.admindocs.urls")),
     path("", include(ns_patterns, namespace="test")),
+    path("company/", views.CompanyView.as_view()),
     path("xview/func/", views.xview_dec(views.xview)),
     path("xview/class/", views.xview_dec(views.XViewClass.as_view())),
     path("xview/callable_object/", views.xview_dec(views.XViewCallableObject())),

tests/admin_docs/views.py

@@ -18 +18 @@
 class XViewCallableObject(View):
     def __call__(self, request):
         return HttpResponse()
+
+
+class CompanyView(View):
+    """
+    This is a view for :model:`myapp.Company`
+    """
+
+    def get(self, request):
+        return HttpResponse()

There is already a ticket for some issues of links in docstrings #27409. I will accept but this might be combined with 27409 in future.

[SAI GANESH S]

PR Link:
​https://github.com/django/django/pull/18747

[Sarah Boyce <42296566+sarahboyce@…>]

In 96839722:

Fixed #35867, Refs #2411 -- Allowed links in admindocs view details summary.