summaryrefslogtreecommitdiff
path: root/docs/src/searx.search.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src/searx.search.rst')
-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