From 2033f30c8df9e6af23876345785ec28ba982d5e5 Mon Sep 17 00:00:00 2001 From: Dennis ten Hoove Date: Fri, 16 Aug 2024 05:14:25 +0200 Subject: [PATCH] [docs] improve Hostname plugin documentation --- searx/plugins/hostnames.py | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/searx/plugins/hostnames.py b/searx/plugins/hostnames.py index 770b00e15d6..6519452db36 100644 --- a/searx/plugins/hostnames.py +++ b/searx/plugins/hostnames.py @@ -1,7 +1,19 @@ # SPDX-License-Identifier: AGPL-3.0-or-later # pylint: disable=too-many-branches -"""In addition to rewriting/replace reslut URLs, the *hoostnames* plugin offers -other features. +""" +.. attention:: + + The **"Hostname replace"** plugin has been replace by **"Hostnames + plugin"**, see :pull:`3463` & :pull:`3552`. + +The **Hostnames plugin** can be enabled by adding it to the +``enabled_plugins`` **list** in the ``setting.yml`` like so. + + .. code:: yaml + + enabled_plugins: + - 'Hostnames plugin' + ... - ``hostnames.replace``: A **mapping** of regular expressions to hostnames to be replaced by other hostnames.