jandieman
/
searxng
mirror of https://github.com/searxng/searxng.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
4,013 Commits 8 Branches 17 Tags 124 MiB
Commit Graph

210 Commits

Author SHA1 Message Date
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
Markus Heiser 2b4526916d edoc: -- makefile.rst fix typo and add extlinks['man'] 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-18 18:32:42 +01:00
Markus Heiser f09459b98a doc: describe Makefile targets 
With the aim to simplify development cycles, started with PR #1756 a Makefile
based boilerplate was added.  This patch adds the missing developer
documentation.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-18 16:11:05 +01:00
Markus Heiser fcd7f4cd12 doc: add note about docs-clean target 
BTW: fix some typos

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-13 15:22:10 +01:00
Markus Heiser e4e578e8a9 doc: theme - make sidebar less eye-catching 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-13 14:58:13 +01:00
Markus Heiser 97b86fd184 doc: document the new reST & gh-pages workflow 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-13 14:57:07 +01:00
Markus Heiser 04eeeb53a1 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
Markus Heiser e9fff4fde6 doc: proofread of the all reST sources (no content change) 
Normalize reST sources with best practice and KISS in mind.

to name a few points:

- simplify reST tables
- make use of ``literal`` markup for monospace rendering
- fix code-blocks for better rendering in HTML
- normalize section header markup
- limit all lines to a maximum of 79 characters
- add option -H to the sudo command used in code blocks
- drop useless indentation of lists
- ...

[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-12 19:20:56 +01:00
Markus Heiser 5b14772b20 doc: installation.rst improve reST markup 
- normalize section header markup
- limit all lines to a maximum of 79 characters
- add option -H to the sudo command used in code blocks
- place *WARNING* lines into a '.. warning::' admonition block
- make use of ``literal`` markup for monospace rendering
- drop useless indentation of lists

[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-12 13:30:12 +01:00
Markus Heiser 0a7479f194 doc: [fix] WARNING: Could not lex literal_block as "json" 
docs/admin/filtron.rst:24: \
   WARNING: Could not lex literal_block as "json". Highlighting skipped.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-12 13:24:18 +01:00
Markus Heiser af2cae6d1d doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx 
- add sphinx extensions
- patch documentation to make use of

These modules help to simplify the reST markup of external references.  BTW it
helps to write more readable reST and form custom brands.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-12 12:39:38 +01:00
Markus Heiser 25fa7da6c8 doc: use customized pocoo theme (pallets-sphinx-themes) 
The old searx theme was a copy of the flask theme.  In the meantime this theme
is available from the python module pallets-sphinx-themes.

This patch makes pallets-sphinx-themes as a (dev) requirement and drops most of
the old and obsolete searx theme settings/files.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
 2019-12-12 12:21:52 +01:00
Noémi Ványi 021e1da4c9 add post about introducing offline engines 2019-10-23 13:06:19 +02:00
pofilo c1ccb25d56 Merge pull request #1389 from bourrel/patch-1 
Update quickstart.rst
 2018-11-29 15:54:56 +01:00
tmikaeld 77494166d2 Formatting... 2018-10-21 11:42:00 +02:00
tmikaeld 10ebe8cec9 Added missing symlink instruction 2018-10-21 11:36:11 +02:00
Léo Bourrel 94af140318 Update quickstart.rst 
Rename `build_grunt` to `grunt_build` as in manage.sh
 2018-08-30 11:14:03 +02:00
Noémi Ványi 20e85275cb remove Gratipay and Flattr from sidebar 2018-01-23 20:43:22 +01:00
Noémi Ványi 2134c7c693 change python-pybabel to python-babel in package requirements 
Closes #1147
 2018-01-17 22:05:10 +01:00
Noémi Ványi 07ef4a3e4a update search api with params and description on syntax 2017-10-23 18:06:49 +02:00
Noémi Ványi 979dd3d96c blog: add post about searx-admin 2017-08-22 21:30:00 +02:00
Adam Tauber 6cc9f56949 [enh] add morty documentation 2017-08-08 15:23:17 +02:00
Noémi Ványi 74d8ed284d add format param to search api 2017-07-09 22:02:29 +02:00
Adam Tauber b92631bf8c various mods: uwsgi setup and version update ++ py3 img src fix ++ new sphinx version - closes #939 2017-06-12 12:37:07 +02:00
Noémi Ványi 93e6258463 add first blog entry on python3 support 2017-05-13 22:16:23 +02:00
James Coleman b8f5c75374 Corrected spelling of ads in user/own-instance.html 2017-04-19 15:29:32 -05:00
Noémi Ványi 1bd51c6de2 rewrite Translation page 2017-03-18 23:57:19 +01:00
Noémi Ványi e43e5af207 bump searx version to 0.11.0 2017-03-18 23:55:20 +01:00
Noémi Ványi 6ecd8e3bd7 installation: nginx mod to sites-enabled 2016-11-20 21:13:37 +01:00
Noémi Ványi d0d2d18a4d fix typos in own instance page 2016-11-05 16:28:32 +01:00
Noémi Ványi 50f25193c1 engine overview fix torrent table 2016-11-05 16:25:51 +01:00
Noémi Ványi f55eea083f generated files of parent 2016-11-05 15:57:37 +01:00
Noémi Ványi 31ea4280bf "why use a personal instance?" page 2016-11-05 15:57:37 +01:00
Noémi Ványi ee18ad780e conf: bump searx version to 0.10.0 2016-11-04 21:53:11 +01:00
Noémi Ványi c2cf46092e docs: fix typos based on #653 2016-11-04 18:38:07 +01:00
Noémi Ványi dca4d276a4 add sample config of filtron 2016-10-30 01:01:22 +02:00
Noemi Vanyi daf736f1dd add possible values of time_range param 2016-09-10 15:12:11 +02:00
Noémi Ványi 013139b036 add embedded search to docs 2016-09-06 18:16:29 +02:00
Noémi Ványi 6d99db7af3 add new search parameter time_range 2016-09-06 18:13:20 +02:00
Noemi Vanyi 9e135f9fab simplify index page 2016-07-15 18:41:05 +02:00
Noemi Vanyi 521f398709 disable breaking "searx" into multiple lines 2016-07-09 23:01:00 +02:00
Noemi Vanyi 2ad8715b32 better API docs && more features in list 2016-07-09 22:31:21 +02:00
Noemi Vanyi ffcceed517 version bump to 0.9.0 && year to 2016 2016-07-09 21:46:20 +02:00
Noemi Vanyi b40d7a2b36 add reverse proxy configuration 2016-04-21 14:30:17 +02:00
Noemi Vanyi 2430baa1fd update install docs on reverse proxy 2016-04-21 13:16:18 +02:00
Noemi Vanyi 9c56154cfe add dev tips to quickstart 2016-04-21 13:15:04 +02:00
Noemi Vanyi 016ab5c1e8 add development quickstart 2016-02-01 21:28:13 +01:00
Thomas Pointhuber cf9bd14a7d [fix] little typo 2016-01-21 16:30:42 +01:00
Thomas Pointhuber fb62d01194 [enh] improve translation documentation 2016-01-21 16:25:40 +01:00
Noemi Vanyi 08d26609a5 update & fix install guide after install refactor 2016-01-10 20:10:53 +01:00
Noemi Vanyi 3b06814192 [doc] rewrite contribution guide 2015-12-10 21:40:22 +01:00
Noemi Vanyi 240802003e [doc] fix small mistakes in engine overview 2015-12-10 21:38:39 +01:00
Noemi Vanyi ae69a58089 [doc] grammar & format fixes in engine overview 2015-12-01 15:32:06 +01:00
Adam Tauber 11d6d80d88 [doc] engines overview added 2015-11-28 19:26:45 +01:00
Adam Tauber 1d6597b407 [enh] initial structure 2015-11-17 23:38:22 +01:00