Merge pull request #52 from edoburu/bugfix/inheritance-diagram

Fix rendering of inheritance diagrams
sphinx-doc · Sep 26, 2023 · 0421d7e · 0421d7e
2 parents c26bf9f + be8c151
commit 0421d7e
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 2 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -5,6 +5,7 @@ Unreleased
 ----------
 
 * Drop support for sphinx < 3.4.0
+* [ `#45 <https://github.com/edoburu/sphinxcontrib-django/issues/45>`_ ] Fix rendering of inheritance diagrams
 
 
 Version 2.4 (2023-07-02)

diff --git a/sphinxcontrib_django/docstrings/classes.py b/sphinxcontrib_django/docstrings/classes.py
@@ -104,7 +104,9 @@ def improve_model_docstring(app: Sphinx, model: models.Model, lines: list[str])
         and "sphinx.ext.graphviz" in app.extensions
         and not any("inheritance-diagram::" in line for line in lines)
     ):
-        lines.append(".. inheritance-diagram::")  # pragma: no cover
+        lines.append("")
+        lines.append(f".. inheritance-diagram:: {model.__module__}.{model.__name__}")
+        lines.append("")
 
 
 def add_db_table_name(app: Sphinx, model: models.Model, lines: list[str]) -> None:

diff --git a/tests/roots/test-docstrings/conf.py b/tests/roots/test-docstrings/conf.py
@@ -5,7 +5,11 @@
 sys.path.insert(0, os.path.abspath("."))
 
 project = "sphinx dummy Test"
-extensions = ["sphinxcontrib_django"]
+extensions = [
+    "sphinxcontrib_django",
+    "sphinx.ext.graphviz",
+    "sphinx.ext.inheritance_diagram",
+]
 
 # Configure Django settings module
 django_settings = "dummy_django_app.settings"

diff --git a/tests/test_class_docstrings.py b/tests/test_class_docstrings.py
@@ -81,6 +81,8 @@ def test_simple_model(app, do_autodoc):
             " :class:`~dummy_django_app.models.ChildModelB`"
         ),
         "",
+        "   .. inheritance-diagram:: dummy_django_app.models.SimpleModel",
+        "",
     ]
 
 
@@ -168,6 +170,8 @@ def test_database_table(app, do_autodoc):
             " :class:`~dummy_django_app.models.ChildModelB`"
         ),
         "",
+        "   .. inheritance-diagram:: dummy_django_app.models.SimpleModel",
+        "",
     ]
 
 
@@ -199,6 +203,8 @@ def test_abstract_model(app, do_autodoc):
             " :class:`~dummy_django_app.models.AbstractModel`"
         ),
         "",
+        "   .. inheritance-diagram:: dummy_django_app.models.AbstractModel",
+        "",
     ]
 
 
@@ -232,6 +238,8 @@ def test_abstract_model_with_tables_names_and_ignore_abstract(app, do_autodoc):
             " :class:`~dummy_django_app.models.AbstractModel`"
         ),
         "",
+        "   .. inheritance-diagram:: dummy_django_app.models.AbstractModel",
+        "",
     ]
 
 
@@ -272,6 +280,8 @@ def test_abstract_model_with_tables_names_and_abstract_show(app, do_autodoc):
             " :class:`~dummy_django_app.models.AbstractModel`"
         ),
         "",
+        "   .. inheritance-diagram:: dummy_django_app.models.AbstractModel",
+        "",
     ]
 
 
@@ -300,6 +310,8 @@ def test_file_model(app, do_autodoc):
             " :class:`~dummy_django_app.models.SimpleModel`"
         ),
         "",
+        "   .. inheritance-diagram:: dummy_django_app.models.FileModel",
+        "",
     ]
 
 
@@ -339,6 +351,8 @@ def test_tagged_item(app, do_autodoc):
             " :class:`~django.contrib.contenttypes.models.ContentType`"
         ),
         "",
+        "   .. inheritance-diagram:: dummy_django_app.models.TaggedItem",
+        "",
     ]
 
 

diff --git a/tests/test_django_configured.py b/tests/test_django_configured.py
@@ -15,4 +15,6 @@ def test_django_configured(app, do_autodoc):
         "   :param id: Primary key: ID",
         "   :type id: ~django.db.models.AutoField",
         "",
+        "   .. inheritance-diagram:: dummy_django_app.models.MonkeyPatched",
+        "",
     ]