Browse Source

[doc] add documentation of Mwmbl engine & autocompleter

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Markus Heiser 1 year ago
parent
commit
b0d2cd5ca9
3 changed files with 41 additions and 1 deletions
  1. 27 0
      docs/dev/engines/online/mwmbl.rst
  2. 2 0
      searx/autocomplete.py
  3. 12 1
      searx/engines/mwmbl.py

+ 27 - 0
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

+ 2 - 0
searx/autocomplete.py

@@ -111,6 +111,8 @@ def google_complete(query, sxng_locale):
 
 
 
 
 def mwmbl(query, _lang):
 def mwmbl(query, _lang):
+    """Autocomplete from Mwmbl_."""
+
     # mwmbl autocompleter
     # mwmbl autocompleter
     url = 'https://api.mwmbl.org/search/complete?{query}'
     url = 'https://api.mwmbl.org/search/complete?{query}'
 
 

+ 12 - 1
searx/engines/mwmbl.py

@@ -1,6 +1,17 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # lint: pylint
 # 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
 from urllib.parse import urlencode