Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a5dad3b7 authored by Markus Heiser's avatar Markus Heiser
Browse files

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



Signed-off-by: default avatarMarkus Heiser <markus.heiser@darmarit.de>
parent 3e18aa6f

docs/admin/engines/index.rst

+5 −2
Original line number Diff line number Diff line
@@ -10,10 +10,13 @@ Engines & Settings 
   - :ref:`engine settings` & :ref:`engine file`



.. toctree::

   :maxdepth: 1

   :maxdepth: 3



   settings

   configured_engines



.. toctree::

   :maxdepth: 1



   private-engines

   recoll

   sql-engines

docs/conf.py

+1 −1
Original line number Diff line number Diff line
@@ -68,7 +68,7 @@ jinja_filters = { 
# Let the Jinja template in configured_engines.rst access documented_modules

# to automatically link documentation for modules if it exists.

def setup(app):

    ENGINES_DOCNAME = 'admin/engines/configured_engines'

    ENGINES_DOCNAME = 'user/configured_engines'



    def before_read_docs(app, env, docnames):

        assert ENGINES_DOCNAME in docnames

docs/dev/reST.rst

+1 −1
Original line number Diff line number Diff line
@@ -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

:origin:`docs/admin/engines.rst` is shown:



.. literalinclude:: ../admin/engines/configured_engines.rst

.. literalinclude:: ../user/configured_engines.rst

   :language: reST

   :start-after: .. _configured engines:

docs/donate.rst

+2 −0
Original line number Diff line number Diff line 
.. _donate:



Donate to searxng.org

=====================

docs/index.rst

+25 −9
Original line number Diff line number Diff line
@@ -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_.

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

   searx project.





.. toctree::

   :maxdepth: 2

   :caption: Contents