kamp/searxng
1
0
Fork 0
mirror of https://github.com/searxng/searxng.git synced 2024-11-16 17:40:11 +01:00
Code
7,448 Commits 6 Branches 17 Tags 132 MiB
9fce459c7f
Commit Graph

29 Commits

Author SHA1 Message Date
Markus Heiser
5720844fcd [doc] rearranges Settings & Engines docs for better readability 
We have built up detailed documentation of the *settings* and the *engines* over
the past few years.  However, this documentation was still spread over various
chapters and was difficult to navigate in its entirety.

This patch rearranges the Settings & Engines documentation for better
readability.

To review new ordered docs::

   make docs.clean docs.live

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2023-07-01 22:45:19 +02:00
Markus Heiser
68a0e1bfc3 [doc] fix tyops in docs/dev/reST.rst 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2023-05-26 11:51:35 +02:00
Markus Heiser
a5dad3b7c8 [doc] slightly reorder the chapters & improve TOCs for better navigation 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2023-04-16 15:21:26 +02:00
Markus Heiser
ba8959ad7c [fix] typos / reported by @kianmeng in searx PR-3366 
[PR-3366] https://github.com/searx/searx/pull/3366

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2022-09-27 18:32:14 +02:00
Alexandre Flament
76cbfbbdda reference docs.searxng.org 2022-01-02 21:18:29 +01:00
Markus Heiser
ecb7e73e03 [brand] docs - normalize project name to SearXNG 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2021-09-13 14:36:24 +02:00
Markus Heiser
340d25b19b [docs] rename 'General Engine Settings' to 'Configured Engines' 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2021-06-04 15:05:58 +02:00
Markus Heiser
d965c63429 [docs] reorder chapter "Engines & Settings" 
- Split chapter "Engines" and rename it into "Engines & Settings"
- Move docs/admin/engines.rst -> docs/admin/engines/engine_settings.rst

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2021-06-04 15:04:38 +02:00
Markus Heiser
28b25185c5 [brand] searxng -- fix links to issue tracker & WEB-GUI 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2021-04-25 14:25:08 +02:00
Markus Heiser
34badee467 [doc] modify docs to fit to the new build boilerplate 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2021-04-23 11:26:22 +02:00
Alexandre Flament
eb1b5289d5 [mod] documentation: change the jinja context doesn't depend on searx.webapp 
Before this commit, in the documentation, the jinja context is 'webapp' and contains
the global variable in the searx.webapp module.

This commit changes this to include only the mandatory variables to build the
documentation.
 2020-12-27 10:00:35 +01:00
Markus Heiser
3beede7ab7 [doc] describe 'make books/{name}.html' and 'books/{name}.pdf' 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-12-24 13:55:22 +01:00
Alexandre Flament
38d32337e7 [mod] documentations & comments: update http://* URL to https://*. 
About http://lesscss.org see https://github.com/less/less-docs/issues/520
 2020-12-04 16:52:25 +01:00
Markus Heiser
aa5f947157 [enh] add 'kernel-include' reST-directive 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-06-18 18:51:31 +02:00
Markus Heiser
4d67164918 Merge branch 'master' of https://github.com/asciimoo/searx into filtron 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-02-23 13:50:22 +01:00
Markus Heiser
a9d184473f docs: fix dead Searx-instance links to https://searx.space 
Related to #1853 / BTW update year of copyright note

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-02-20 18:11:34 +01:00
Markus Heiser
a99c65dd01 docs: misc marginal fixes 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-02-05 07:37:26 +01:00
Markus Heiser
bdf392093a build requirements: add a shell script static analysis tool 
ShellCheck: https://github.com/koalaman/shellcheck

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2020-01-08 18:09:36 +01:00
Markus Heiser
d6f2802e4b docs(dev): add more markups to reST primer 
- Literal blocks
- Unicode substitution
- Horizontal list
- Math equations

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-28 01:01:11 +01:00
Markus Heiser
92afe68d65 doc(dev): reST/sphinx add tabbed views extension (sphinx_tabs.tabs) 
See issue #1785:

  idea: in the doc, provide installation instructions with one tab per
  distrubution

preview (don't bookmark):

  https://return42.github.io/searx/dev/reST.html#tabbed-views

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-26 10:26:12 +01:00
Markus Heiser
c8645d6e37 doc: reST-primer -- imrpove desription of definition lists 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-23 09:37:51 +01:00
Markus Heiser
31db843c9c doc: CSS - fix alignment of code block in figure blocks 
BTW: minor profread of reST.rst

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-22 14:08:57 +01:00
Markus Heiser
d1154202bc doc: add reST templating // incl. generic engine tabe 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-21 17:13:38 +01:00
Markus Heiser
c2b9aa0c2f docs: reST-primer describe table markup (WIP) 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-20 20:39:14 +01:00
Markus Heiser
b201f84595 docs: reST-primer continued proofreading (WIP) 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-20 17:47:24 +01:00
Markus Heiser
ae7cb5937e docs: reST-primer first proofreading (WIP) 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-20 12:10:43 +01:00
Markus Heiser
b82f61f704 doc: reST primer -- describe admonitions & customize their CSS 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-20 11:01:41 +01:00
Markus Heiser
e1566e68aa doc: add content to reST primer (WIP) // linuxdoc 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-19 23:36:53 +01:00
Markus Heiser
bee19a76f7 doc: add reST primer (inital / WIP) 
preview: https://return42.github.io/searx/dev/reST.html

includes:

- :class: rst-example // admonitions with (rendered) reST markup example
- extlinks to docutils

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-19 17:05:50 +01:00