summaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2021-12-29 17:38:13 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2022-01-03 10:20:54 +0100
commitde819bb1f5be4e5f9e26d09ab40585684f284c4a (patch)
tree94d59a0810d70d61250e59fbdaac1238c027a34e /docs/dev
parent458b7fb72d9429af346578ba37625f3d45607f03 (diff)
downloadsearxng-de819bb1f5be4e5f9e26d09ab40585684f284c4a.tar.gz
searxng-de819bb1f5be4e5f9e26d09ab40585684f284c4a.zip
[docs] move searxng_extra/ stuff to the developer section.
Stuff in folder searxng_extra/ is not suitable for normal users and should only be used by developers. The script searxng_extra/standalone_searx.py must not give the impression that it improves privacy. [1] [1] https://github.com/searxng/searxng/pull/651#issuecomment-1001389726 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/index.rst1
-rw-r--r--docs/dev/searxng_extra/index.rst14
-rw-r--r--docs/dev/searxng_extra/standalone_searx.py.rst9
3 files changed, 24 insertions, 0 deletions
diff --git a/docs/dev/index.rst b/docs/dev/index.rst
index 93c914bbb..39be0885c 100644
--- a/docs/dev/index.rst
+++ b/docs/dev/index.rst
@@ -16,3 +16,4 @@ Developer documentation
lxcdev
makefile
reST
+ searxng_extra/index
diff --git a/docs/dev/searxng_extra/index.rst b/docs/dev/searxng_extra/index.rst
new file mode 100644
index 000000000..f38bb3154
--- /dev/null
+++ b/docs/dev/searxng_extra/index.rst
@@ -0,0 +1,14 @@
+.. _searxng_extra:
+
+======================================================
+Tooling box ``searxng_extra`` for developers and users
+======================================================
+
+In the folder :origin:`searxng_extra/` we maintain some tools useful for
+developers.
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents
+
+ standalone_searx.py
diff --git a/docs/dev/searxng_extra/standalone_searx.py.rst b/docs/dev/searxng_extra/standalone_searx.py.rst
new file mode 100644
index 000000000..7cbbccfde
--- /dev/null
+++ b/docs/dev/searxng_extra/standalone_searx.py.rst
@@ -0,0 +1,9 @@
+
+.. _standalone_searx.py:
+
+=====================================
+``searxng_extra/standalone_searx.py``
+=====================================
+
+.. automodule:: searxng_extra.standalone_searx
+ :members: