summaryrefslogtreecommitdiff
path: root/docs/dev/search_api.rst
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2019-12-21 17:13:38 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2019-12-21 17:13:38 +0100
commitd1154202bcd27a7cf3a1bed524ee6b24955df8af (patch)
tree320cd72039e356142df8dcaed4e61cda8b750807 /docs/dev/search_api.rst
parentc2b9aa0c2fe5e9eee24619d2fe563da01d9ecf87 (diff)
doc: add reST templating // incl. generic engine tabe
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev/search_api.rst')
-rw-r--r--docs/dev/search_api.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/dev/search_api.rst b/docs/dev/search_api.rst
index 158cab7c5..8ca804b8c 100644
--- a/docs/dev/search_api.rst
+++ b/docs/dev/search_api.rst
@@ -14,6 +14,13 @@ Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
Parameters
==========
+.. sidebar:: Further reading ..
+
+ - :ref:`engines generic`
+ - :ref:`configured engines`
+ - :ref:`engine settings`
+ - :ref:`engine file`
+
``q`` : required
The search query. This string is passed to external search services. Thus,
searx supports syntax of each search service. For example, ``site:github.com