From 707d6270c80426b54aeaa0ac0acd80ded45df533 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Sun, 10 Mar 2024 18:08:25 +0100
Subject: [PATCH] [doc] engine: mullvad leta

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 docs/dev/engines/online/mullvad_leta.rst | 13 +++++++++++++
 searx/engines/mullvad_leta.py            | 13 ++++++++++---
 searx/settings.yml                       |  1 +
 3 files changed, 24 insertions(+), 3 deletions(-)
 create mode 100644 docs/dev/engines/online/mullvad_leta.rst

diff --git a/docs/dev/engines/online/mullvad_leta.rst b/docs/dev/engines/online/mullvad_leta.rst
new file mode 100644
index 000000000..63aef019b
--- /dev/null
+++ b/docs/dev/engines/online/mullvad_leta.rst
@@ -0,0 +1,13 @@
+.. _voidlinux mullvad_leta:
+
+============
+Mullvad-Leta
+============
+
+.. contents:: Contents
+   :depth: 2
+   :local:
+   :backlinks: entry
+
+.. automodule:: searx.engines.mullvad_leta
+   :members:
diff --git a/searx/engines/mullvad_leta.py b/searx/engines/mullvad_leta.py
index 0d2450006..121331bf3 100644
--- a/searx/engines/mullvad_leta.py
+++ b/searx/engines/mullvad_leta.py
@@ -1,9 +1,9 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
 
-"""This is the implementation of the Mullvad-Leta meta-search engine
+"""This is the implementation of the Mullvad-Leta meta-search engine.
 
-This engine _REQUIRES_ that searxng operate within a Mullvad VPN
+This engine **REQUIRES** that searxng operate within a Mullvad VPN
 
 If using docker, consider using gluetun for easily connecting to the Mullvad
 
@@ -13,6 +13,12 @@ Otherwise, follow instructions provided by Mullvad for enabling the VPN on Linux
 
 - https://mullvad.net/en/help/install-mullvad-app-linux
 
+.. hint::
+
+   The :py:obj:`EngineTraits` is empty by default.  Maintainers have to run
+   ``make data.traits`` (in the Mullvad VPN / :py:obj:`fetch_traits`) and rebase
+   the modified JSON file ``searx/data/engine_traits.json`` on every single
+   update of SearXNG!
 """
 
 from typing import TYPE_CHECKING
@@ -125,7 +131,8 @@ def response(resp: Response):
 def fetch_traits(engine_traits: EngineTraits):
     """Fetch languages and regions from Mullvad-Leta
 
-    WARNING
+    .. warning::
+
         Fetching the engine traits also requires a Mullvad VPN connection. If
         not connected, then an error message will print and no traits will be
         updated.
diff --git a/searx/settings.yml b/searx/settings.yml
index 4c849e94e..eec2d82db 100644
--- a/searx/settings.yml
+++ b/searx/settings.yml
@@ -1217,6 +1217,7 @@ engines:
       require_api_key: false
       results: JSON
 
+  # read https://docs.searxng.org/dev/engines/online/mullvad_leta.html
   # - name: mullvadleta
   #   engine: mullvad_leta
   #   use_cache: true  # Only 100 non-cache searches per day, suggested only for private instances