diff options
| author | Noémi Ványi <kvch@users.noreply.github.com> | 2020-06-28 20:28:12 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-28 20:28:12 +0200 |
| commit | 93cbd85b8a5becdf69e6d70dd7c60f7122531262 (patch) | |
| tree | 90d202af89e02fc3e83d5bdf4a924b05ff197261 /docs/user | |
| parent | 385e9b5c9e2d1caa73f99dac0bf1be1c46505121 (diff) | |
| parent | f9f5974968ce767c24eea8c8a651d0e3945fc01b (diff) | |
Merge branch 'master' into duckduckgo_correction
Diffstat (limited to 'docs/user')
| -rw-r--r-- | docs/user/conf.py | 19 | ||||
| -rw-r--r-- | docs/user/index.rst | 3 | ||||
| -rw-r--r-- | docs/user/own-instance.rst | 10 | ||||
| -rw-r--r-- | docs/user/public_instances.rst | 3 |
4 files changed, 27 insertions, 8 deletions
diff --git a/docs/user/conf.py b/docs/user/conf.py new file mode 100644 index 000000000..53ade4b63 --- /dev/null +++ b/docs/user/conf.py @@ -0,0 +1,19 @@ +# -*- coding: utf-8; mode: python -*- +"""Configuration for the Searx user handbook +""" +project = 'Searx User-HB' +version = release = VERSION_STRING + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index' # startdocname + , 'searx-user-hb.tex' # targetname + , '' # take title from .rst + , author # author + , 'howto' # documentclass + , False # toctree_only + ), +] + diff --git a/docs/user/index.rst b/docs/user/index.rst index b13aca216..96d11bf8a 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -3,7 +3,8 @@ User documentation ================== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: Contents search_syntax own-instance diff --git a/docs/user/own-instance.rst b/docs/user/own-instance.rst index a2f736562..af415b61d 100644 --- a/docs/user/own-instance.rst +++ b/docs/user/own-instance.rst @@ -2,8 +2,10 @@ Why use a private instance? =========================== -"Is it worth to run my own instance?" is a common question among searx users. -Before answering this question, see what options a searx user has. + *"Is it worth to run my own instance?"* + +\.\. is a common question among searx users. Before answering this question, +see what options a searx user has. Public instances are open to everyone who has access to its URL. Usually, these are operated by unknown parties (from the users' point of view). Private @@ -42,9 +44,9 @@ hidden from visited result pages. What are the consequences of using public instances? ---------------------------------------------------- -If someone uses a public instance, he/she has to trust the administrator of that +If someone uses a public instance, they have to trust the administrator of that instance. This means that the user of the public instance does not know whether -his/her requests are logged, aggregated and sent or sold to a third party. +their requests are logged, aggregated and sent or sold to a third party. Also, public instances without proper protection are more vulnerable to abusing the search service, In this case the external service in exchange returns diff --git a/docs/user/public_instances.rst b/docs/user/public_instances.rst deleted file mode 100644 index f58ab7a02..000000000 --- a/docs/user/public_instances.rst +++ /dev/null @@ -1,3 +0,0 @@ -:orphan: - -This page page has been moved to `searx.space <https://searx.space/>`__ |