Revert "Added code references to search results. (#1947)"

This reverts commit fa56d9b.

Author: alexgmin

djangoproject/scss/_style.scss

@@ -2635,39 +2635,6 @@ table.docutils th {
             color: var(--search-mark-text);
         }
     }
-
-    .code-links {
-        margin-top: 15px;
-        margin-left: 10px;
-        list-style-type: none;
-        padding-left: 0;
-
-        a {
-            &:active,
-            &:focus,
-            &:hover {
-                code {
-                    color: var(--primary);
-                }
-                .meta {
-                    color: var(--text-light);
-                }
-            }
-        }
-
-        code {
-            color: var(--primary-accent);
-            font-weight: 700;
-        }
-
-        div {
-            margin: 0;
-            .meta {
-                margin: 5px 0 0;
-                color: var(--body-fg);
-            }
-        }
-    }
 }
 
 .list-links-small {

docs/builder.py

@@ -4,7 +4,6 @@
 """
 
 import json
-import multiprocessing
 import os
 import shutil
 import subprocess
@@ -18,9 +17,6 @@
 from django.core.management import BaseCommand, call_command
 from django.db.models import Q
 from django.utils.translation import to_locale
-from sphinx.application import Sphinx
-from sphinx.config import Config
-from sphinx.errors import SphinxError
 
 from ...models import DocumentRelease
 
@@ -209,30 +205,29 @@ def build_doc_release(self, release, force=False, interactive=False):
 
             if self.verbosity >= 2:
                 self.stdout.write(f"  building {builder} ({source_dir} -> {build_dir})")
-            # Retrieve the extensions from the conf.py so we can append to them.
-            conf_extensions = Config.read(source_dir.resolve()).extensions
-            extensions = [*conf_extensions, "docs.builder"]
             try:
-                Sphinx(
-                    srcdir=source_dir,
-                    confdir=source_dir,
-                    outdir=build_dir,
-                    doctreedir=build_dir.joinpath(".doctrees"),
-                    buildername=builder,
-                    # Translated docs builds generate a lot of warnings, so send
-                    # stderr to stdout to be logged (rather than generating an email)
-                    warning=sys.stdout,
-                    parallel=multiprocessing.cpu_count(),
-                    verbosity=self.verbosity,
-                    confoverrides={
-                        "language": to_locale(release.lang),
-                        "extensions": extensions,
-                    },
-                ).build()
-            except SphinxError as e:
+                # Translated docs builds generate a lot of warnings, so send
+                # stderr to stdout to be logged (rather than generating an
+                # email)
+                subprocess.check_call(
+                    [
+                        "sphinx-build",
+                        "-b",
+                        builder,
+                        "-D",
+                        "language=%s" % to_locale(release.lang),
+                        "-j",
+                        "auto",
+                        "-Q" if self.verbosity == 0 else "-q",
+                        str(source_dir),  # Source file directory
+                        str(build_dir),  # Destination directory
+                    ],
+                    stderr=sys.stdout,
+                )
+            except subprocess.CalledProcessError:
                 self.stderr.write(
-                    "sphinx-build returned an error (release %s, builder %s): %s"
-                    % (release, builder, str(e))
+                    "sphinx-build returned an error (release %s, builder %s)"
+                    % (release, builder)
                 )
                 return
 

docs/management/commands/update_docs.py

@@ -2,7 +2,7 @@
 import html
 import json
 import operator
-from functools import partial, reduce
+from functools import reduce
 from pathlib import Path
 
 from django.conf import settings
@@ -262,12 +262,6 @@ def search(self, query_text, release):
                 query_text, config=models.F("config"), search_type="websearch"
             )
             search_rank = SearchRank(models.F("search"), search_query)
-            search = partial(
-                SearchHeadline,
-                start_sel=START_SEL,
-                stop_sel=STOP_SEL,
-                config=models.F("config"),
-            )
             base_qs = (
                 self.prefetch_related(
                     Prefetch(
@@ -280,18 +274,21 @@ def search(self, query_text, release):
                 )
                 .filter(release_id=release.id)
                 .annotate(
-                    headline=search("title", search_query),
-                    highlight=search(
-                        KeyTextTransform("body", "metadata"),
+                    headline=SearchHeadline(
+                        "title",
                         search_query,
+                        start_sel=START_SEL,
+                        stop_sel=STOP_SEL,
+                        config=models.F("config"),
                     ),
-                    searched_python_objects=search(
-                        KeyTextTransform("python_objects_search", "metadata"),
+                    highlight=SearchHeadline(
+                        KeyTextTransform("body", "metadata"),
                         search_query,
-                        highlight_all=True,
+                        start_sel=START_SEL,
+                        stop_sel=STOP_SEL,
+                        config=models.F("config"),
                     ),
                     breadcrumbs=models.F("metadata__breadcrumbs"),
-                    python_objects=models.F("metadata__python_objects"),
                 )
                 .only(
                     "path",

docs/models.py

@@ -48,21 +48,6 @@ <h2 class="result-title">
             {% if result.highlight %}
               …&nbsp;{{ result.highlight|cut:"¶"|safe }}&nbsp;…
             {% endif %}
-            {% code_links result.searched_python_objects result.python_objects as result_code_links %}
-            {% if result_code_links %}
-              <ul class="code-links">
-                {% for name, value in result_code_links.items %}
-                  <li>
-                    <a href="{% url 'document-detail' lang=result.release.lang version=result.release.version url=result.path host 'docs' %}#{{ value.full_path }}">
-                      <div>
-                        <code>{{ name }}</code>
-                        {% if value.module_path %}<div class="meta">{{ value.module_path }}</div>{% endif %}
-                      </div>
-                    </a>
-                  </li>
-                {% endfor %}
-              </ul>
-            {% endif %}
           </dd>
         {% endfor %}
       </dl>

docs/templates/docs/search_results.html

@@ -12,7 +12,7 @@
 from ..forms import DocSearchForm
 from ..models import DocumentRelease
 from ..search import START_SEL, STOP_SEL
-from ..utils import get_doc_path, get_doc_root, get_module_path
+from ..utils import get_doc_path, get_doc_root
 
 register = template.Library()
 
@@ -121,68 +121,3 @@ def generate_scroll_to_text_fragment(highlighted_text):
     # Due to Python code such as timezone.now(), remove the space after a bracket.
     single_spaced = re.sub(r"([(\[])\s", r"\1", single_spaced)
     return f"#:~:text={quote(single_spaced)}"
-
-
-@register.simple_tag
-def code_links(searched_python_objects, python_objects):
-    """
-    Processes a highlighted search result (from a `SearchHeadline` annotation)
-    to extract Python object references and map them to their full paths.
-
-    Args:
-        searched_python_objects (str):
-            A string from a `SearchHeadline` queryset annotation, containing
-            highlighted Python object names wrapped with `START_SEL` and `STOP_SEL`.
-            Example:
-                "QuerySet {START_SEL}select_related{STOP_SEL} prefetch_related"
-
-        python_objects (dict):
-            A dictionary mapping object short names to their full path. This is
-            generated from PythonObjectsJSONHTMLBuilder.
-            Example:
-                {
-                    "QuerySet": "django.db.models.query.QuerySet",
-                    "QuerySet.select_related": (
-                        "django.db.models.query.QuerySet.select_related"
-                    ),
-                    "QuerySet.prefetch_related": (
-                        "django.db.models.query.QuerySet.prefetch_related"
-                    ),
-                }
-
-    Returns:
-        dict: A sorted dictionary where:
-            - Keys are matched Python object short names.
-            - Values are dictionaries containing:
-                - `"full_path"` (str): The full path of the object.
-                - `"module_path"` (str): The module path derived from the object name.
-            Example:
-                {
-                    "QuerySet.select_related": {
-                        "full_path": "django.db.models.query.QuerySet.select_related",
-                        "module_path": "django.db.models.query",
-                    }
-                }
-    """
-    if not searched_python_objects or START_SEL not in searched_python_objects:
-        return {}
-    python_objects_matched_short_names = [
-        word.replace(START_SEL, "").replace(STOP_SEL, "")
-        for word in searched_python_objects.split(" ")
-        if START_SEL in word
-    ]
-    matched_reference = {}
-    # Map "select_related" to "QuerySet.select_related" in code_references.
-    reference_map = {key.split(".")[-1]: key for key in python_objects.keys()}
-    for short_name in python_objects_matched_short_names:
-        if full_path := python_objects.get(short_name):
-            matched_reference[short_name] = {
-                "full_path": full_path,
-                "module_path": get_module_path(short_name, full_path),
-            }
-        elif name := reference_map.get(short_name):
-            matched_reference[name] = {
-                "full_path": python_objects[name],
-                "module_path": get_module_path(name, python_objects[name]),
-            }
-    return dict(sorted(matched_reference.items()))