Excluded website Documents from DocsSitemap.

Author: sarahboyce

djangoproject/settings/common.py

@@ -313,3 +313,5 @@
 DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
 
 FORMS_URLFIELD_ASSUME_HTTPS = True
+
+DEFAULT_LANGUAGE_CODE = "en"

docs/sitemaps.py

@@ -1,6 +1,7 @@
 from django.contrib.sitemaps import Sitemap
 
 from .models import Document
+from .search import DocumentationCategory
 
 
 class DocsSitemap(Sitemap):
@@ -10,6 +11,7 @@ def __init__(self, lang):
     def items(self):
         return (
             Document.objects.filter(release__lang=self.lang)
+            .exclude(metadata__parents=DocumentationCategory.WEBSITE)
             .order_by("-release__release", "path")
             .select_related("release__release")
         )

docs/tests/test_views.py

@@ -1,5 +1,6 @@
 from http import HTTPStatus
 
+from django.conf import settings
 from django.contrib.sites.models import Site
 from django.test import SimpleTestCase, TestCase
 from django.urls import reverse, set_urlconf
@@ -252,8 +253,16 @@ def test_sitemap_index(self):
 
     def test_sitemap(self):
         doc_release = DocumentRelease.objects.create()
-        document = Document.objects.create(release=doc_release)
-        sitemap = DocsSitemap("en")
+        document = Document.objects.create(
+            release=doc_release,
+            metadata={"parents": DocumentationCategory.TOPICS},
+        )
+        Document.objects.create(
+            release=doc_release,
+            metadata={"parents": DocumentationCategory.WEBSITE},
+            path="example",
+        )
+        sitemap = DocsSitemap(settings.DEFAULT_LANGUAGE_CODE)
         urls = sitemap.get_urls()
         self.assertEqual(len(urls), 1)
         url_info = urls[0]