summaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorAlexandre Flament <alex@al-f.net>2021-09-09 11:23:57 +0200
committerAlexandre Flament <alex@al-f.net>2021-09-10 10:58:22 +0200
commit0b27c8698f7b5bbca5083cf234fabbc7d7308349 (patch)
treef49a2fc2104f730e642ff7817d334ac14c925d24 /docs/src
parentb941763e206a572018b70a9218ecd01c133c942d (diff)
downloadsearxng-0b27c8698f7b5bbca5083cf234fabbc7d7308349.tar.gz
searxng-0b27c8698f7b5bbca5083cf234fabbc7d7308349.zip
[doc] update docs/dev/plugins.rst
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/searx.search.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/src/searx.search.rst b/docs/src/searx.search.rst
new file mode 100644
index 000000000..ad76d4183
--- /dev/null
+++ b/docs/src/searx.search.rst
@@ -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