summaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2023-06-30 18:07:02 +0200
committerMarkus Heiser <markus.heiser@darmarIT.de>2023-07-01 22:45:19 +0200
commit5720844fcdc8601798e10544e2fd25ce4f2ad099 (patch)
treeaf611e4aef436253f4fda9504d06e05e2621114d /docs/src
parent8e8d8dabe9b17c9db8db7432c6bc063d9ae980d1 (diff)
downloadsearxng-5720844fcdc8601798e10544e2fd25ce4f2ad099.tar.gz
searxng-5720844fcdc8601798e10544e2fd25ce4f2ad099.zip
[doc] rearranges Settings & Engines docs for better readability
We have built up detailed documentation of the *settings* and the *engines* over the past few years. However, this documentation was still spread over various chapters and was difficult to navigate in its entirety. This patch rearranges the Settings & Engines documentation for better readability. To review new ordered docs:: make docs.clean docs.live Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/index.rst1
-rw-r--r--docs/src/searx.botdetection.rst2
-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.annas_archive.rst2
-rw-r--r--docs/src/searx.engines.bing.rst43
-rw-r--r--docs/src/searx.engines.demo_offline.rst9
-rw-r--r--docs/src/searx.engines.demo_online.rst9
-rw-r--r--docs/src/searx.engines.google.rst76
-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.tineye.rst9
-rw-r--r--docs/src/searx.engines.torznab.rst2
-rw-r--r--docs/src/searx.engines.wikipedia.rst27
-rw-r--r--docs/src/searx.engines.yahoo.rst8
-rw-r--r--docs/src/searx.locales.rst2
-rw-r--r--docs/src/searx.search.processors.rst4
20 files changed, 4 insertions, 294 deletions
diff --git a/docs/src/index.rst b/docs/src/index.rst
index efa7a509b..fd16e7635 100644
--- a/docs/src/index.rst
+++ b/docs/src/index.rst
@@ -8,7 +8,6 @@ every item from the source code, but we will add documentation when requested.
.. toctree::
:maxdepth: 2
- :caption: Contents
:glob:
searx.*
diff --git a/docs/src/searx.botdetection.rst b/docs/src/searx.botdetection.rst
index 093414ec8..48261ceac 100644
--- a/docs/src/searx.botdetection.rst
+++ b/docs/src/searx.botdetection.rst
@@ -4,7 +4,7 @@
Bot Detection
=============
-.. contents:: Contents
+.. contents::
:depth: 2
:local:
:backlinks: entry
diff --git a/docs/src/searx.engine.archlinux.rst b/docs/src/searx.engine.archlinux.rst
deleted file mode 100644
index be48b1859..000000000
--- a/docs/src/searx.engine.archlinux.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. _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
deleted file mode 100644
index 84348e2d0..000000000
--- a/docs/src/searx.engine.dailymotion.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-.. _dailymotion engine:
-
-===========
-Dailymotion
-===========
-
-.. automodule:: searx.engines.dailymotion
- :members:
diff --git a/docs/src/searx.engine.duckduckgo.rst b/docs/src/searx.engine.duckduckgo.rst
deleted file mode 100644
index 1646d4984..000000000
--- a/docs/src/searx.engine.duckduckgo.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-.. _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
deleted file mode 100644
index 651a04e68..000000000
--- a/docs/src/searx.enginelib.rst
+++ /dev/null
@@ -1,17 +0,0 @@
-.. _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.annas_archive.rst b/docs/src/searx.engines.annas_archive.rst
deleted file mode 100644
index 377f42082..000000000
--- a/docs/src/searx.engines.annas_archive.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-.. automodule:: searx.engines.annas_archive
- :members:
diff --git a/docs/src/searx.engines.bing.rst b/docs/src/searx.engines.bing.rst
deleted file mode 100644
index 6b7bba8f2..000000000
--- a/docs/src/searx.engines.bing.rst
+++ /dev/null
@@ -1,43 +0,0 @@
-.. _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.demo_offline.rst b/docs/src/searx.engines.demo_offline.rst
deleted file mode 100644
index 9424244fd..000000000
--- a/docs/src/searx.engines.demo_offline.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. _demo offline engine:
-
-===================
-Demo Offline Engine
-===================
-
-.. automodule:: searx.engines.demo_offline
- :members:
-
diff --git a/docs/src/searx.engines.demo_online.rst b/docs/src/searx.engines.demo_online.rst
deleted file mode 100644
index 0a8c8e985..000000000
--- a/docs/src/searx.engines.demo_online.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. _demo online engine:
-
-==================
-Demo Online Engine
-==================
-
-.. automodule:: searx.engines.demo_online
- :members:
-
diff --git a/docs/src/searx.engines.google.rst b/docs/src/searx.engines.google.rst
deleted file mode 100644
index 9c15325f8..000000000
--- a/docs/src/searx.engines.google.rst
+++ /dev/null
@@ -1,76 +0,0 @@
-.. _google engines:
-
-==============
-Google Engines
-==============
-
-.. contents:: Contents
- :depth: 2
- :local:
- :backlinks: entry
-
-
-.. _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`_. 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:
-
-Google WEB
-==========
-
-.. automodule:: searx.engines.google
- :members:
-
-.. _google autocomplete:
-
-Google Autocomplete
-====================
-
-.. autofunction:: searx.autocomplete.google_complete
-
-.. _google images engine:
-
-Google Images
-=============
-
-.. automodule:: searx.engines.google_images
- :members:
-
-.. _google videos engine:
-
-Google Videos
-=============
-
-.. automodule:: searx.engines.google_videos
- :members:
-
-.. _google news engine:
-
-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
deleted file mode 100644
index 8e1576ea0..000000000
--- a/docs/src/searx.engines.peertube.rst
+++ /dev/null
@@ -1,27 +0,0 @@
-.. _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
deleted file mode 100644
index 4ce96b27e..000000000
--- a/docs/src/searx.engines.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-.. _searx.engines:
-
-=================
-SearXNG's engines
-=================
-
-.. automodule:: searx.engines
- :members:
diff --git a/docs/src/searx.engines.startpage.rst b/docs/src/searx.engines.startpage.rst
deleted file mode 100644
index c885d8f1b..000000000
--- a/docs/src/searx.engines.startpage.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-.. _startpage engines:
-
-=================
-Startpage engines
-=================
-
-.. contents:: Contents
- :depth: 2
- :local:
- :backlinks: entry
-
-.. automodule:: searx.engines.startpage
- :members:
diff --git a/docs/src/searx.engines.tineye.rst b/docs/src/searx.engines.tineye.rst
deleted file mode 100644
index 79e24cfb8..000000000
--- a/docs/src/searx.engines.tineye.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. _tineye engine:
-
-======
-Tineye
-======
-
-.. automodule:: searx.engines.tineye
- :members:
-
diff --git a/docs/src/searx.engines.torznab.rst b/docs/src/searx.engines.torznab.rst
deleted file mode 100644
index 0b96e18ec..000000000
--- a/docs/src/searx.engines.torznab.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-.. automodule:: searx.engines.torznab
- :members:
diff --git a/docs/src/searx.engines.wikipedia.rst b/docs/src/searx.engines.wikipedia.rst
deleted file mode 100644
index e644cd645..000000000
--- a/docs/src/searx.engines.wikipedia.rst
+++ /dev/null
@@ -1,27 +0,0 @@
-.. _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.engines.yahoo.rst b/docs/src/searx.engines.yahoo.rst
deleted file mode 100644
index df08550ca..000000000
--- a/docs/src/searx.engines.yahoo.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-.. _yahoo engine:
-
-============
-Yahoo Engine
-============
-
-.. automodule:: searx.engines.yahoo
- :members:
diff --git a/docs/src/searx.locales.rst b/docs/src/searx.locales.rst
index 2f13bfca1..0de49a5e1 100644
--- a/docs/src/searx.locales.rst
+++ b/docs/src/searx.locales.rst
@@ -4,7 +4,7 @@
Locales
=======
-.. contents:: Contents
+.. contents::
:depth: 2
:local:
:backlinks: entry
diff --git a/docs/src/searx.search.processors.rst b/docs/src/searx.search.processors.rst
index 390680657..3bb4c44bc 100644
--- a/docs/src/searx.search.processors.rst
+++ b/docs/src/searx.search.processors.rst
@@ -4,7 +4,7 @@
Search processors
=================
-.. contents:: Contents
+.. contents::
:depth: 2
:local:
:backlinks: entry
@@ -34,7 +34,7 @@ Online currency processor
.. automodule:: searx.search.processors.online_currency
:members:
-Online Dictionary processor
+Online dictionary processor
===========================
.. automodule:: searx.search.processors.online_dictionary