searxng/docs/user/index.rst

================
User information
================

.. contents:: Contents
   :depth: 3
   :local:
   :backlinks: entry

.. toctree::
   :maxdepth: 2

   search-syntax
   configured_engines
   about
Sphinx doc: rename "User documentation" to "User Information" 2022-03-16 22:23:33 +01:00			`================`
			`User information`
			`================`
doc: moved reST sources in the right folder (much clearer) Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2019-12-12 19:48:42 +01:00
[mod] replace /help by /info pages and include pages in project docs This patch implements a bolierplate to share content from info-pages of the SearXNG instance (URL /info) with the project documentation (path /docs/user). The info pages are using Markdown (CommonMark), to include them in the project documentation (reST) the myst-parser [1] is used in the Sphinx-doc build chain. If base_url is known (defined in settings.yml) links to the instance are also inserted into the project documentation:: searxng_extra/docs_prebuild [1] https://www.sphinx-doc.org/en/master/usage/markdown.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2022-03-12 10:18:08 +01:00			`.. contents:: Contents`
			`:depth: 3`
			`:local:`
			`:backlinks: entry`

[doc] slightly reorder the chapters & improve TOCs for better navigation Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2023-04-16 14:23:27 +02:00			`.. toctree::`
			`:maxdepth: 2`
[mod] replace /help by /info pages and include pages in project docs This patch implements a bolierplate to share content from info-pages of the SearXNG instance (URL /info) with the project documentation (path /docs/user). The info pages are using Markdown (CommonMark), to include them in the project documentation (reST) the myst-parser [1] is used in the Sphinx-doc build chain. If base_url is known (defined in settings.yml) links to the instance are also inserted into the project documentation:: searxng_extra/docs_prebuild [1] https://www.sphinx-doc.org/en/master/usage/markdown.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2022-03-12 10:18:08 +01:00
[doc] slightly reorder the chapters & improve TOCs for better navigation Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2023-04-16 14:23:27 +02:00			`search-syntax`
			`configured_engines`
			`about`