summaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/searx.engine.archlinux.rst9
-rw-r--r--docs/src/searx.engine.dailymotion.rst8
-rw-r--r--docs/src/searx.engine.duckduckgo.rst22
-rw-r--r--docs/src/searx.enginelib.rst17
-rw-r--r--docs/src/searx.engines.bing.rst43
-rw-r--r--docs/src/searx.engines.google.rst27
-rw-r--r--docs/src/searx.engines.peertube.rst27
-rw-r--r--docs/src/searx.engines.rst8
-rw-r--r--docs/src/searx.engines.startpage.rst13
-rw-r--r--docs/src/searx.engines.wikipedia.rst27
-rw-r--r--docs/src/searx.locales.rst12
-rw-r--r--docs/src/searx.search.processors.rst47
12 files changed, 253 insertions, 7 deletions
diff --git a/docs/src/searx.engine.archlinux.rst b/docs/src/searx.engine.archlinux.rst
new file mode 100644
index 000000000..be48b1859
--- /dev/null
+++ b/docs/src/searx.engine.archlinux.rst
@@ -0,0 +1,9 @@
+.. _archlinux engine:
+
+==========
+Arch Linux
+==========
+
+.. automodule:: searx.engines.archlinux
+ :members:
+
diff --git a/docs/src/searx.engine.dailymotion.rst b/docs/src/searx.engine.dailymotion.rst
new file mode 100644
index 000000000..84348e2d0
--- /dev/null
+++ b/docs/src/searx.engine.dailymotion.rst
@@ -0,0 +1,8 @@
+.. _dailymotion engine:
+
+===========
+Dailymotion
+===========
+
+.. automodule:: searx.engines.dailymotion
+ :members:
diff --git a/docs/src/searx.engine.duckduckgo.rst b/docs/src/searx.engine.duckduckgo.rst
new file mode 100644
index 000000000..1646d4984
--- /dev/null
+++ b/docs/src/searx.engine.duckduckgo.rst
@@ -0,0 +1,22 @@
+.. _duckduckgo engines:
+
+=================
+DukcDukGo engines
+=================
+
+.. contents:: Contents
+ :depth: 2
+ :local:
+ :backlinks: entry
+
+.. automodule:: searx.engines.duckduckgo
+ :members:
+
+.. automodule:: searx.engines.duckduckgo_images
+ :members:
+
+.. automodule:: searx.engines.duckduckgo_definitions
+ :members:
+
+.. automodule:: searx.engines.duckduckgo_weather
+ :members:
diff --git a/docs/src/searx.enginelib.rst b/docs/src/searx.enginelib.rst
new file mode 100644
index 000000000..651a04e68
--- /dev/null
+++ b/docs/src/searx.enginelib.rst
@@ -0,0 +1,17 @@
+.. _searx.enginelib:
+
+============
+Engine model
+============
+
+.. automodule:: searx.enginelib
+ :members:
+
+.. _searx.enginelib.traits:
+
+=============
+Engine traits
+=============
+
+.. automodule:: searx.enginelib.traits
+ :members:
diff --git a/docs/src/searx.engines.bing.rst b/docs/src/searx.engines.bing.rst
new file mode 100644
index 000000000..6b7bba8f2
--- /dev/null
+++ b/docs/src/searx.engines.bing.rst
@@ -0,0 +1,43 @@
+.. _bing engines:
+
+============
+Bing Engines
+============
+
+.. contents:: Contents
+ :depth: 2
+ :local:
+ :backlinks: entry
+
+
+.. _bing web engine:
+
+Bing WEB
+========
+
+.. automodule:: searx.engines.bing
+ :members:
+
+.. _bing images engine:
+
+Bing Images
+===========
+
+.. automodule:: searx.engines.bing_images
+ :members:
+
+.. _bing videos engine:
+
+Bing Videos
+===========
+
+.. automodule:: searx.engines.bing_videos
+ :members:
+
+.. _bing news engine:
+
+Bing News
+=========
+
+.. automodule:: searx.engines.bing_news
+ :members:
diff --git a/docs/src/searx.engines.google.rst b/docs/src/searx.engines.google.rst
index 2d10b5eea..9c15325f8 100644
--- a/docs/src/searx.engines.google.rst
+++ b/docs/src/searx.engines.google.rst
@@ -12,15 +12,21 @@ Google Engines
.. _google API:
-google API
+Google API
==========
.. _Query Parameter Definitions:
https://developers.google.com/custom-search/docs/xml_results#WebSearch_Query_Parameter_Definitions
+SearXNG's implementation of the Google API is mainly done in
+:py:obj:`get_google_info <searx.engines.google.get_google_info>`.
+
For detailed description of the *REST-full* API see: `Query Parameter
-Definitions`_. Not all parameters can be appied and some engines are *special*
-(e.g. :ref:`google news engine`).
+Definitions`_. The linked API documentation can sometimes be helpful during
+reverse engineering. However, we cannot use it in the freely accessible WEB
+services; not all parameters can be applied and some engines are more *special*
+than other (e.g. :ref:`google news engine`).
+
.. _google web engine:
@@ -30,6 +36,13 @@ Google WEB
.. automodule:: searx.engines.google
:members:
+.. _google autocomplete:
+
+Google Autocomplete
+====================
+
+.. autofunction:: searx.autocomplete.google_complete
+
.. _google images engine:
Google Images
@@ -53,3 +66,11 @@ Google News
.. automodule:: searx.engines.google_news
:members:
+
+.. _google scholar engine:
+
+Google Scholar
+==============
+
+.. automodule:: searx.engines.google_scholar
+ :members:
diff --git a/docs/src/searx.engines.peertube.rst b/docs/src/searx.engines.peertube.rst
new file mode 100644
index 000000000..8e1576ea0
--- /dev/null
+++ b/docs/src/searx.engines.peertube.rst
@@ -0,0 +1,27 @@
+.. _peertube engines:
+
+================
+Peertube Engines
+================
+
+.. contents:: Contents
+ :depth: 2
+ :local:
+ :backlinks: entry
+
+
+.. _peertube video engine:
+
+Peertube Video
+==============
+
+.. automodule:: searx.engines.peertube
+ :members:
+
+.. _sepiasearch engine:
+
+SepiaSearch
+===========
+
+.. automodule:: searx.engines.sepiasearch
+ :members:
diff --git a/docs/src/searx.engines.rst b/docs/src/searx.engines.rst
index 687fdb0b2..4ce96b27e 100644
--- a/docs/src/searx.engines.rst
+++ b/docs/src/searx.engines.rst
@@ -1,8 +1,8 @@
-.. _load_engines:
+.. _searx.engines:
-============
-Load Engines
-============
+=================
+SearXNG's engines
+=================
.. automodule:: searx.engines
:members:
diff --git a/docs/src/searx.engines.startpage.rst b/docs/src/searx.engines.startpage.rst
new file mode 100644
index 000000000..c885d8f1b
--- /dev/null
+++ b/docs/src/searx.engines.startpage.rst
@@ -0,0 +1,13 @@
+.. _startpage engines:
+
+=================
+Startpage engines
+=================
+
+.. contents:: Contents
+ :depth: 2
+ :local:
+ :backlinks: entry
+
+.. automodule:: searx.engines.startpage
+ :members:
diff --git a/docs/src/searx.engines.wikipedia.rst b/docs/src/searx.engines.wikipedia.rst
new file mode 100644
index 000000000..e644cd645
--- /dev/null
+++ b/docs/src/searx.engines.wikipedia.rst
@@ -0,0 +1,27 @@
+.. _wikimedia engines:
+
+=========
+Wikimedia
+=========
+
+.. contents:: Contents
+ :depth: 2
+ :local:
+ :backlinks: entry
+
+
+.. _wikipedia engine:
+
+Wikipedia
+=========
+
+.. automodule:: searx.engines.wikipedia
+ :members:
+
+.. _wikidata engine:
+
+Wikidata
+=========
+
+.. automodule:: searx.engines.wikidata
+ :members:
diff --git a/docs/src/searx.locales.rst b/docs/src/searx.locales.rst
index 579247aff..2f13bfca1 100644
--- a/docs/src/searx.locales.rst
+++ b/docs/src/searx.locales.rst
@@ -4,5 +4,17 @@
Locales
=======
+.. contents:: Contents
+ :depth: 2
+ :local:
+ :backlinks: entry
+
.. automodule:: searx.locales
:members:
+
+
+SearXNG's locale codes
+======================
+
+.. automodule:: searx.sxng_locales
+ :members:
diff --git a/docs/src/searx.search.processors.rst b/docs/src/searx.search.processors.rst
new file mode 100644
index 000000000..390680657
--- /dev/null
+++ b/docs/src/searx.search.processors.rst
@@ -0,0 +1,47 @@
+.. _searx.search.processors:
+
+=================
+Search processors
+=================
+
+.. contents:: Contents
+ :depth: 2
+ :local:
+ :backlinks: entry
+
+
+Abstract processor class
+========================
+
+.. automodule:: searx.search.processors.abstract
+ :members:
+
+Offline processor
+=================
+
+.. automodule:: searx.search.processors.offline
+ :members:
+
+Online processor
+================
+
+.. automodule:: searx.search.processors.online
+ :members:
+
+Online currency processor
+=========================
+
+.. automodule:: searx.search.processors.online_currency
+ :members:
+
+Online Dictionary processor
+===========================
+
+.. automodule:: searx.search.processors.online_dictionary
+ :members:
+
+Online URL search processor
+===========================
+
+.. automodule:: searx.search.processors.online_url_search
+ :members: