Excluded website Documents from DocsSitemap.

Author: sarahboyce

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/templates/docs/search_results.html

@@ -20,19 +20,11 @@
       {% endfor %}
     </search>
     <h2>
-      {% if release.is_dev %}
-        {% blocktranslate count num_results=paginator.count trimmed %}
-          {{ num_results }} result for <em>{{ query }}</em> in the development version
-        {% plural %}
-          {{ num_results }} results for <em>{{ query }}</em> in the development version
-        {% endblocktranslate %}
-      {% else %}
-        {% blocktranslate count num_results=paginator.count trimmed %}
-          {{ num_results }} result for <em>{{ query }}</em> in version {{ version }}
-        {% plural %}
-          {{ num_results }} results for <em>{{ query }}</em> in version {{ version }}
-        {% endblocktranslate %}
-      {% endif %}
+      {% blocktranslate count num_results=paginator.count trimmed %}
+        {{ num_results }} result for <em>{{ query }}</em>
+      {% plural %}
+        {{ num_results }} results for <em>{{ query }}</em>
+      {% endblocktranslate %}
     </h2>
   {% else %}
     <h2>{% translate "No search query given" %}</h2>

docs/tests/test_views.py

@@ -96,9 +96,7 @@ def test_search_type_filter_all(self):
             headers={"host": "docs.djangoproject.localhost:8000"},
         )
         self.assertEqual(response.status_code, 200)
-        self.assertContains(
-            response, "5 results for <em>generic</em> in version 5.1", html=True
-        )
+        self.assertContains(response, "5 results for <em>generic</em>", html=True)
         self.assertContains(response, self.active_filter, count=1)
         self.assertContains(response, f"{self.active_filter}All</a>", html=True)
 
@@ -112,7 +110,7 @@ def test_search_type_filter_by_doc_types(self):
                 self.assertEqual(response.status_code, 200)
                 self.assertContains(
                     response,
-                    "1 result for <em>generic</em> in version 5.1",
+                    "1 result for <em>generic</em>",
                     html=True,
                 )
                 self.assertContains(response, self.active_filter, count=1)
@@ -127,9 +125,7 @@ def test_search_category_filter_invalid_doc_categories(self):
             headers={"host": "docs.djangoproject.localhost:8000"},
         )
         self.assertEqual(response.status_code, 200)
-        self.assertContains(
-            response, "5 results for <em>generic</em> in version 5.1", html=True
-        )
+        self.assertContains(response, "5 results for <em>generic</em>", html=True)
         self.assertContains(response, self.active_filter, count=1)
         self.assertContains(response, f"{self.active_filter}All</a>", html=True)
 
@@ -143,9 +139,7 @@ def test_search_category_filter_no_results(self):
         self.assertContains(
             response, f"{self.active_filter}API Reference</a>", html=True
         )
-        self.assertContains(
-            response, "0 results for <em>potato</em> in version 5.1", html=True
-        )
+        self.assertContains(response, "0 results for <em>potato</em>", html=True)
         self.assertContains(
             response,
             'Please try searching <a href="?q=potato">all documentation results</a>.',
@@ -253,7 +247,7 @@ def test_code_links(self):
                 self.assertEqual(response.status_code, 200)
                 self.assertContains(
                     response,
-                    f"1 result for <em>{query}</em> in version 5.1",
+                    f"1 result for <em>{query}</em>",
                     html=True,
                 )
                 self.assertContains(response, expected_code_links, html=True)
@@ -282,7 +276,15 @@ def test_sitemap_index(self):
 
     def test_sitemap(self):
         doc_release = DocumentRelease.objects.create()
-        document = Document.objects.create(release=doc_release)
+        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)