Browse Source

[doc] slightly reorder the chapters & improve TOCs for better navigation

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Markus Heiser 2 years ago
parent
commit
a5dad3b7c8

+ 5 - 2
docs/admin/engines/index.rst

@@ -10,10 +10,13 @@ Engines & Settings
    - :ref:`engine settings` & :ref:`engine file`
    - :ref:`engine settings` & :ref:`engine file`
 
 
 .. toctree::
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 3
 
 
    settings
    settings
-   configured_engines
+
+.. toctree::
+   :maxdepth: 1
+
    private-engines
    private-engines
    recoll
    recoll
    sql-engines
    sql-engines

+ 1 - 1
docs/conf.py

@@ -68,7 +68,7 @@ jinja_filters = {
 # Let the Jinja template in configured_engines.rst access documented_modules
 # Let the Jinja template in configured_engines.rst access documented_modules
 # to automatically link documentation for modules if it exists.
 # to automatically link documentation for modules if it exists.
 def setup(app):
 def setup(app):
-    ENGINES_DOCNAME = 'admin/engines/configured_engines'
+    ENGINES_DOCNAME = 'user/configured_engines'
 
 
     def before_read_docs(app, env, docnames):
     def before_read_docs(app, env, docnames):
         assert ENGINES_DOCNAME in docnames
         assert ENGINES_DOCNAME in docnames

+ 1 - 1
docs/dev/reST.rst

@@ -1284,7 +1284,7 @@ install` (with SearXNG modules installed).  We use this e.g. to build chapter:
 :ref:`configured engines`.  Below the jinja directive from the
 :ref:`configured engines`.  Below the jinja directive from the
 :origin:`docs/admin/engines.rst` is shown:
 :origin:`docs/admin/engines.rst` is shown:
 
 
-.. literalinclude:: ../admin/engines/configured_engines.rst
+.. literalinclude:: ../user/configured_engines.rst
    :language: reST
    :language: reST
    :start-after: .. _configured engines:
    :start-after: .. _configured engines:
 
 

+ 2 - 0
docs/donate.rst

@@ -1,3 +1,5 @@
+.. _donate:
+
 Donate to searxng.org
 Donate to searxng.org
 =====================
 =====================
 
 

+ 25 - 9
docs/index.rst

@@ -11,21 +11,37 @@ SearXNG can be used over Tor for online anonymity.
 Get started with SearXNG by using one of the instances listed at searx.space_.
 Get started with SearXNG by using one of the instances listed at searx.space_.
 If you don't trust anyone, you can set up your own, see :ref:`installation`.
 If you don't trust anyone, you can set up your own, see :ref:`installation`.
 
 
-.. sidebar::  Features
+.. sidebar::  features
 
 
-   - Self hosted
-   - No user tracking
-   - No user profiling
-   - About 70 supported search engines
-   - Easy integration with any search engine
-   - Cookies are not used by default
-   - Secure, encrypted connections (HTTPS/SSL)
+   - :ref:`self hosted <installation>`
+   - :ref:`no user tracking / no profiling <SearXNG protect privacy>`
+   - script & cookies are optional
+   - secure, encrypted connections
+   - :ref:`about 130 search engines <configured engines>`
+   - `about 60 translations <https://translate.codeberg.org/projects/searxng/searxng/>`_
+   - about 100 `well maintained <https://uptime.searxng.org/>`__ instances on searx.space_
+   - :ref:`easy integration of search engines <demo online engine>`
+   - professional development: `CI <https://github.com/searxng/searxng/actions>`_,
+     `quality assurance <https://dev.searxng.org/>`_ &
+     `automated tested UI <https://dev.searxng.org/screenshots.html>`_
 
 
-.. sidebar:: info
+.. sidebar:: be a part
+
+   SearXNG is driven by an open community, come join us!  You can :ref:`donate
+   <donate>`, but much more we appreciate contributions.  Don't hesitate, no
+   need to be an *expert*, everyone can contribute:
+
+   - `help to improve translations <https://translate.codeberg.org/projects/searxng/searxng/>`_
+   - `discuss with the community <https://matrix.to/#/#searxng:matrix.org>`_
+   - report bugs & suggestions
+   - ...
+
+.. sidebar:: the origin
 
 
    SearXNG development has been started in the middle of 2021 as a fork of the
    SearXNG development has been started in the middle of 2021 as a fork of the
    searx project.
    searx project.
 
 
+
 .. toctree::
 .. toctree::
    :maxdepth: 2
    :maxdepth: 2
    :caption: Contents
    :caption: Contents

+ 10 - 3
docs/own-instance.rst

@@ -2,10 +2,15 @@
 Why use a private instance?
 Why use a private instance?
 ===========================
 ===========================
 
 
-  *"Is it worth to run my own instance?"*
+.. sidebar:: Is it worth to run my own instance?
 
 
-\.\. is a common question among SearXNG users.  Before answering this question,
-see what options a SearXNG user has.
+  \.\. is a common question among SearXNG users.  Before answering this
+  question, see what options a SearXNG user has.
+
+.. contents:: Contents
+   :depth: 2
+   :local:
+   :backlinks: entry
 
 
 Public instances are open to everyone who has access to its URL.  Usually, these
 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
 are operated by unknown parties (from the users' point of view).  Private
@@ -16,6 +21,8 @@ single user one which runs on the user's laptop.
 To gain more insight on how these instances work let's dive into how SearXNG
 To gain more insight on how these instances work let's dive into how SearXNG
 protects its users.
 protects its users.
 
 
+.. _SearXNG protect privacy:
+
 How does SearXNG protect privacy?
 How does SearXNG protect privacy?
 =================================
 =================================
 
 

+ 4 - 0
docs/user/about.rst

@@ -0,0 +1,4 @@
+.. _about SearXNG:
+
+.. include:: about.md
+   :parser: myst_parser.sphinx_

+ 0 - 0
docs/admin/engines/configured_engines.rst → docs/user/configured_engines.rst


+ 5 - 5
docs/user/index.rst

@@ -7,9 +7,9 @@ User information
    :local:
    :local:
    :backlinks: entry
    :backlinks: entry
 
 
+.. toctree::
+   :maxdepth: 2
 
 
-.. _search-syntax:
-
-.. include:: search-syntax.md
-   :parser: myst_parser.sphinx_
-
+   search-syntax
+   configured_engines
+   about

+ 4 - 0
docs/user/search-syntax.rst

@@ -0,0 +1,4 @@
+.. _search-syntax:
+
+.. include:: search-syntax.md
+   :parser: myst_parser.sphinx_