[doc] build from commit 94a0b415ef587e013df9e7350667b752a3822e90gh-pages

17 files changed, 314 insertions, 0 deletions

diff --git a/_sources/src/index.rst.txt b/_sources/src/index.rst.txt
new file mode 100644
index 000000000..fd16e7635
--- /dev/null
+++ b/_sources/src/index.rst.txt
@@ -0,0 +1,13 @@
+===========
+Source-Code
+===========
+
+This is a partial documentation of our source code.  We are not aiming to document
+every item from the source code, but we will add documentation when requested.
+
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   searx.*
diff --git a/_sources/src/searx.babel_extract.rst.txt b/_sources/src/searx.babel_extract.rst.txt
new file mode 100644
index 000000000..741d67fc1
--- /dev/null
+++ b/_sources/src/searx.babel_extract.rst.txt
@@ -0,0 +1,8 @@
+.. _searx.babel_extract:
+
+===============================
+Custom message extractor (i18n)
+===============================
+
+.. automodule:: searx.babel_extract
+  :members:
diff --git a/_sources/src/searx.botdetection.rst.txt b/_sources/src/searx.botdetection.rst.txt
new file mode 100644
index 000000000..04cb81dfd
--- /dev/null
+++ b/_sources/src/searx.botdetection.rst.txt
@@ -0,0 +1,62 @@
+.. _botdetection:
+
+=============
+Bot Detection
+=============
+
+.. contents::
+   :depth: 2
+   :local:
+   :backlinks: entry
+
+.. automodule:: searx.botdetection
+  :members:
+
+.. _botdetection ip_lists:
+
+IP lists
+========
+
+.. automodule:: searx.botdetection.ip_lists
+  :members:
+
+
+.. _botdetection rate limit:
+
+Rate limit
+==========
+
+.. automodule:: searx.botdetection.ip_limit
+  :members:
+
+.. automodule:: searx.botdetection.link_token
+  :members:
+
+
+.. _botdetection probe headers:
+
+Probe HTTP headers
+==================
+
+.. automodule:: searx.botdetection.http_accept
+  :members:
+
+.. automodule:: searx.botdetection.http_accept_encoding
+  :members:
+
+.. automodule:: searx.botdetection.http_accept_language
+  :members:
+
+.. automodule:: searx.botdetection.http_connection
+  :members:
+
+.. automodule:: searx.botdetection.http_user_agent
+  :members:
+
+.. _botdetection config:
+
+Config
+======
+
+.. automodule:: searx.botdetection.config
+  :members:
diff --git a/_sources/src/searx.exceptions.rst.txt b/_sources/src/searx.exceptions.rst.txt
new file mode 100644
index 000000000..72117e148
--- /dev/null
+++ b/_sources/src/searx.exceptions.rst.txt
@@ -0,0 +1,8 @@
+.. _searx.exceptions:
+
+==================
+SearXNG Exceptions
+==================
+
+.. automodule:: searx.exceptions
+  :members:
diff --git a/_sources/src/searx.favicons.rst.txt b/_sources/src/searx.favicons.rst.txt
new file mode 100644
index 000000000..c1c6a500b
--- /dev/null
+++ b/_sources/src/searx.favicons.rst.txt
@@ -0,0 +1,48 @@
+.. _favicons source:
+
+=================
+Favicons (source)
+=================
+
+.. contents::
+   :depth: 2
+   :local:
+   :backlinks: entry
+
+.. automodule:: searx.favicons
+   :members:
+
+.. _favicons.config:
+
+Favicons Config
+===============
+
+.. automodule:: searx.favicons.config
+   :members:
+
+.. _favicons.proxy:
+
+Favicons Proxy
+==============
+
+.. automodule:: searx.favicons.proxy
+   :members:
+
+.. _favicons.resolver:
+
+Favicons Resolver
+=================
+
+.. automodule:: searx.favicons.resolvers
+   :members:
+
+.. _favicons.cache:
+
+Favicons Cache
+==============
+
+.. automodule:: searx.favicons.cache
+   :members:
+
+
+
diff --git a/_sources/src/searx.infopage.rst.txt b/_sources/src/searx.infopage.rst.txt
new file mode 100644
index 000000000..243e5b0bd
--- /dev/null
+++ b/_sources/src/searx.infopage.rst.txt
@@ -0,0 +1,8 @@
+.. _searx.infopage:
+
+================
+Online ``/info``
+================
+
+.. automodule:: searx.infopage
+  :members:
diff --git a/_sources/src/searx.locales.rst.txt b/_sources/src/searx.locales.rst.txt
new file mode 100644
index 000000000..9882e7890
--- /dev/null
+++ b/_sources/src/searx.locales.rst.txt
@@ -0,0 +1,15 @@
+.. _searx.locales:
+
+=======
+Locales
+=======
+
+.. contents::
+   :depth: 2
+   :local:
+   :backlinks: entry
+
+.. automodule:: searx.locales
+   :members:
+
+
diff --git a/_sources/src/searx.plugins.hostnames.rst.txt b/_sources/src/searx.plugins.hostnames.rst.txt
new file mode 100644
index 000000000..5d0365536
--- /dev/null
+++ b/_sources/src/searx.plugins.hostnames.rst.txt
@@ -0,0 +1,9 @@
+.. _hostnames plugin:
+
+================
+Hostnames plugin
+================
+
+.. automodule:: searx.plugins.hostnames
+  :members:
+
diff --git a/_sources/src/searx.plugins.tor_check.rst.txt b/_sources/src/searx.plugins.tor_check.rst.txt
new file mode 100644
index 000000000..905328ebf
--- /dev/null
+++ b/_sources/src/searx.plugins.tor_check.rst.txt
@@ -0,0 +1,9 @@
+.. _tor check plugin:
+
+================
+Tor check plugin
+================
+
+.. automodule:: searx.plugins.tor_check
+  :members:
+
diff --git a/_sources/src/searx.plugins.unit_converter.rst.txt b/_sources/src/searx.plugins.unit_converter.rst.txt
new file mode 100644
index 000000000..48d495d80
--- /dev/null
+++ b/_sources/src/searx.plugins.unit_converter.rst.txt
@@ -0,0 +1,9 @@
+.. _unit converter plugin:
+
+=====================
+Unit converter plugin
+=====================
+
+.. automodule:: searx.plugins.unit_converter
+   :members:
+
diff --git a/_sources/src/searx.redisdb.rst.txt b/_sources/src/searx.redisdb.rst.txt
new file mode 100644
index 000000000..625378c91
--- /dev/null
+++ b/_sources/src/searx.redisdb.rst.txt
@@ -0,0 +1,8 @@
+.. _redis db:
+
+========
+Redis DB
+========
+
+.. automodule:: searx.redisdb
+  :members:
diff --git a/_sources/src/searx.redislib.rst.txt b/_sources/src/searx.redislib.rst.txt
new file mode 100644
index 000000000..b4604574c
--- /dev/null
+++ b/_sources/src/searx.redislib.rst.txt
@@ -0,0 +1,8 @@
+.. _searx.redis:
+
+=============
+Redis Library
+=============
+
+.. automodule:: searx.redislib
+  :members:
diff --git a/_sources/src/searx.search.processors.rst.txt b/_sources/src/searx.search.processors.rst.txt
new file mode 100644
index 000000000..3bb4c44bc
--- /dev/null
+++ b/_sources/src/searx.search.processors.rst.txt
@@ -0,0 +1,47 @@
+.. _searx.search.processors:
+
+=================
+Search processors
+=================
+
+.. 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:
diff --git a/_sources/src/searx.search.rst.txt b/_sources/src/searx.search.rst.txt
new file mode 100644
index 000000000..ad76d4183
--- /dev/null
+++ b/_sources/src/searx.search.rst.txt
@@ -0,0 +1,38 @@
+.. _searx.search:
+
+======
+Search
+======
+
+.. autoclass:: searx.search.EngineRef
+  :members:
+
+.. autoclass:: searx.search.SearchQuery
+  :members:
+
+.. autoclass:: searx.search.Search
+
+  .. attribute:: search_query
+    :type: searx.search.SearchQuery
+
+  .. attribute:: result_container
+    :type: searx.results.ResultContainer
+
+  .. automethod:: search() -> searx.results.ResultContainer
+
+.. autoclass:: searx.search.SearchWithPlugins
+  :members:
+
+  .. attribute:: search_query
+    :type: searx.search.SearchQuery
+
+  .. attribute:: result_container
+    :type: searx.results.ResultContainer
+
+  .. attribute:: ordered_plugin_list
+    :type: typing.List
+
+  .. attribute:: request
+    :type: flask.request
+
+  .. automethod:: search() -> searx.results.ResultContainer
diff --git a/_sources/src/searx.settings.rst.txt b/_sources/src/searx.settings.rst.txt
new file mode 100644
index 000000000..1496c407c
--- /dev/null
+++ b/_sources/src/searx.settings.rst.txt
@@ -0,0 +1,8 @@
+.. _searx.settings_loader:
+
+===============
+Settings Loader
+===============
+
+.. automodule:: searx.settings_loader
+   :members:
diff --git a/_sources/src/searx.sqlitedb.rst.txt b/_sources/src/searx.sqlitedb.rst.txt
new file mode 100644
index 000000000..f984ee286
--- /dev/null
+++ b/_sources/src/searx.sqlitedb.rst.txt
@@ -0,0 +1,8 @@
+.. _sqlite db:
+
+=========
+SQLite DB
+=========
+
+.. automodule:: searx.sqlitedb
+   :members:
diff --git a/_sources/src/searx.utils.rst.txt b/_sources/src/searx.utils.rst.txt
new file mode 100644
index 000000000..6496700c1
--- /dev/null
+++ b/_sources/src/searx.utils.rst.txt
@@ -0,0 +1,8 @@
+.. _searx.utils:
+
+=================================
+Utility functions for the engines
+=================================
+
+.. automodule:: searx.utils
+  :members: