summaryrefslogtreecommitdiff
path: root/searx
diff options
context:
space:
mode:
authorDennis ten Hoove <dennistenhoove@protonmail.com>2024-08-16 05:14:25 +0200
committerMarkus Heiser <markus.heiser@darmarIT.de>2024-08-21 14:28:04 +0200
commit2033f30c8df9e6af23876345785ec28ba982d5e5 (patch)
treeaadcfd4c00c885a6f2360c9d526f249124ee9a79 /searx
parentfe6bac5a08b8dfc8d91478f5ed78bd584ec9c147 (diff)
downloadsearxng-2033f30c8df9e6af23876345785ec28ba982d5e5.tar.gz
searxng-2033f30c8df9e6af23876345785ec28ba982d5e5.zip
[docs] improve Hostname plugin documentation
Diffstat (limited to 'searx')
-rw-r--r--searx/plugins/hostnames.py16
1 files changed, 14 insertions, 2 deletions
diff --git a/searx/plugins/hostnames.py b/searx/plugins/hostnames.py
index 770b00e15..6519452db 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.