[fix] doc: drop the contents:: directive, name the plugin consistently

Furo renders its own page-local table of contents and reports an error
when a page adds one with contents::.  No other page in the tree uses
that directive; these two now follow suit.

The plugin is named "AI Summary" where the name of the plugin is meant,
and "AI summary" where the generated text itself is meant.  That also
fixes the entry in the plugin navigation, which takes its label from the
page title.

Two references to the configuration page rendered as its title, the bare
YAML key "ai_summary:", which reads as a typo in a sentence.  They now
carry explicit link text.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
jasonwitty
2026-08-10 16:17:53 -07:00
co-authored by Claude Opus 5
parent b6eed9a993
commit 6b50b23467
5 changed files with 12 additions and 22 deletions
+2 -2
View File
@@ -1,5 +1,5 @@
# SPDX-License-Identifier: AGPL-3.0-or-later
"""Implementations needed for the AI summary plugin
"""Implementations needed for the AI Summary plugin
(:py:obj:`searx.plugins.ai_summary`)."""
# pylint: disable=too-few-public-methods
@@ -30,7 +30,7 @@ application setup by :py:obj:`searx.plugins.ai_summary.SXNGPlugin.init`."""
class SettingsAISummary(msgspec.Struct, kw_only=True, forbid_unknown_fields=True):
"""Options for configuring the AI summary plugin.
"""Options for configuring the AI Summary plugin.
.. code:: yaml
+2 -2
View File
@@ -1,5 +1,5 @@
# SPDX-License-Identifier: AGPL-3.0-or-later
"""Implementation of the AI summary plugin, which shows a generated answer above
"""Implementation of the AI Summary plugin, which shows a generated answer above
the search results. The answer comes from an LLM server that implements the
`OpenAI chat completions API`_ (Ollama, vLLM, llama.cpp, LM Studio, Hugging Face
TGI, ...) and that the administrator runs.
@@ -135,7 +135,7 @@ class SXNGPlugin(Plugin):
self.info = PluginInfo(
id=self.id,
name=gettext("AI summary"),
name=gettext("AI Summary"),
description=gettext(
"Show an AI generated summary of the search query on top of the"
" result page (uses a local LLM server, see the settings below)."
+1 -1
View File
@@ -287,7 +287,7 @@ plugins:
# '(.*\.)?youtu\.be$': 'yt.example.com'
#
# Configuration of the "AI summary plugin", for more details see
# Configuration of the "AI Summary plugin", for more details see
# https://docs.searxng.org/admin/settings/settings_ai_summary.html
#
# ai_summary: