Use the database for docs rendering

Author: charlesroelli

docs/management/commands/update_docs.py

@@ -278,6 +278,9 @@ def zipfile_inclusion_filter(file_path):
 
         json_built_dir = parent_build_dir / "_built" / "json"
         documents = gen_decoded_documents(json_built_dir)
+        with open(json_built_dir / "globalcontext.json") as context:
+            release.global_context = json.load(context)
+        release.save()
         release.sync_to_db(documents)
 
     def update_git(self, url, destdir, changed_dir="."):

docs/migrations/0008_documentrelease_global_context.py

@@ -0,0 +1,18 @@
+# Generated by Django 6.0.4 on 2026-05-06 09:20
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("docs", "0007_add_docs_search_vector"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="documentrelease",
+            name="global_context",
+            field=models.JSONField(default=dict),
+        ),
+    ]

docs/models.py

@@ -111,6 +111,7 @@ class DocumentRelease(models.Model):
         limit_choices_to={"status": "f"},
         on_delete=models.CASCADE,
     )
+    global_context = models.JSONField(default=dict)
     is_default = models.BooleanField(default=False)
 
     objects = DocumentReleaseQuerySet.as_manager()

docs/templates/docs/doc.html

@@ -166,11 +166,11 @@ <h3 id="breadcrumbs-header">{% trans "You are here:" %}</h3>
         <ul>
           <li>
             <a href="{% url 'document-index' lang=lang version=version host 'docs' %}">{% blocktrans %}Django {{ version }} documentation{% endblocktrans %}</a>
-            {% for p in doc.parents %}
-              <ul><li><a href="{{ p.link }}">{{ p.title|safe }}</a>
+            {% for p in doc.breadcrumbs %}
+              <ul><li><a href="{% url 'document-detail' lang=lang version=version url=p.path host 'docs' %}">{{ p.title|safe }}</a>
             {% endfor %}
             <ul><li>{% block current-page-title %}{{ doc.title|safe }}{% endblock current-page-title %}</li></ul>
-            {% for p in doc.parents %}</li></ul>{% endfor %}
+            {% for p in doc.breadcrumbs %}</li></ul>{% endfor %}
           </li>
         </ul>
       </nav>

docs/views.py

@@ -79,9 +79,18 @@ def load_json_file(path):
         version
     )
 
+    try:
+        doc = Document.objects.get(
+            release=release, path__in=[url, f"{url}index"]
+        ).metadata
+    except Document.DoesNotExist:
+        # We won't find e.g. the genindex page nor partially
+        # translated documents in the database.
+        doc = load_json_file(doc_path)
+
     context = {
-        "doc": load_json_file(doc_path),
-        "env": load_json_file(docroot / "globalcontext.json"),
+        "doc": doc,
+        "env": release.global_context,
         "lang": lang,
         "version": version,
         "canonical_version": canonical_version,