summaryrefslogtreecommitdiff
path: root/docs/dev/search_api.rst
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarIT.de>2019-12-28 13:55:20 +0100
committerGitHub <noreply@github.com>2019-12-28 13:55:20 +0100
commitf6d66c0f6f1d8f1f583d9000ee0123450cce8130 (patch)
tree74c5ca5d49c9b62508d9a68addfe45a409e9f39e /docs/dev/search_api.rst
parenta52a638ba88466c587fd8afa744434711b1e4822 (diff)
parentb91e07bbf156241f6236b7e26d389e10e37553a3 (diff)
Merge pull request #1776 from return42/makefile-doc
doc: describe Makefile targets & add reST primer
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