From b0d2cd5ca9d2ca167551f0a84cd7121453ee51b5 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Wed, 23 Aug 2023 23:13:46 +0200
Subject: [PATCH] [doc] add documentation of Mwmbl engine & autocompleter

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 docs/dev/engines/online/mwmbl.rst | 27 +++++++++++++++++++++++++++
 searx/autocomplete.py             |  2 ++
 searx/engines/mwmbl.py            | 13 ++++++++++++-
 3 files changed, 41 insertions(+), 1 deletion(-)
 create mode 100644 docs/dev/engines/online/mwmbl.rst

diff --git a/docs/dev/engines/online/mwmbl.rst b/docs/dev/engines/online/mwmbl.rst
new file mode 100644
index 000000000..8eac7d7c5
--- /dev/null
+++ b/docs/dev/engines/online/mwmbl.rst
@@ -0,0 +1,27 @@
+.. _Mwmbl engine:
+
+============
+Mwmbl Engine
+============
+
+.. contents::
+   :depth: 2
+   :local:
+   :backlinks: entry
+
+
+.. _mwmbl web engine:
+
+Mwmbl WEB
+=========
+
+.. automodule:: searx.engines.mwmbl
+  :members:
+
+
+.. _mwmbl autocomplete:
+
+Mwmbl Autocomplete
+==================
+
+.. autofunction:: searx.autocomplete.mwmbl
diff --git a/searx/autocomplete.py b/searx/autocomplete.py
index 4f674dca7..58655e26f 100644
--- a/searx/autocomplete.py
+++ b/searx/autocomplete.py
@@ -111,6 +111,8 @@ def google_complete(query, sxng_locale):
 
 
 def mwmbl(query, _lang):
+    """Autocomplete from Mwmbl_."""
+
     # mwmbl autocompleter
     url = 'https://api.mwmbl.org/search/complete?{query}'
 
diff --git a/searx/engines/mwmbl.py b/searx/engines/mwmbl.py
index 1253d0be4..f4905401d 100644
--- a/searx/engines/mwmbl.py
+++ b/searx/engines/mwmbl.py
@@ -1,6 +1,17 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
-"""mwmbl (general)
+"""Mwmbl_ is a non-profit, ad-free, free-libre and free-lunch search engine with
+a focus on useability and speed.
+
+.. hint::
+
+   At the moment it is little more than an idea together with a proof of concept
+   implementation of the web front-end and search technology on a small index.
+   Mwmbl_ does not support regions, languages, safe-search or time range.
+   search.
+
+.. _Mwmbl: https://github.com/mwmbl/mwmbl
+
 """
 
 from urllib.parse import urlencode