summaryrefslogtreecommitdiff
path: root/docs/dev
AgeCommit message (Collapse)Author
2020-02-04docs: add some documentation about the tooling box ./utils/*Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-01-08build requirements: add a shell script static analysis toolMarkus Heiser
ShellCheck: https://github.com/koalaman/shellcheck Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-30docs(admin): moved settings description from wiki to docsMarkus Heiser
Move wiki entry https://github.com/asciimoo/searx/wiki/settings.yml into admin section of the docs (#1785). Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-30docs(dev): fix minor markup typosMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-28docs(dev): add more markups to reST primerMarkus Heiser
- Literal blocks - Unicode substitution - Horizontal list - Math equations Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-26doc(dev): reST/sphinx add tabbed views extension (sphinx_tabs.tabs)Markus Heiser
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-25docs(dev): add refs to to gitmoji and Semantic PR in contrib sectionMarkus Heiser
preview (don't bookmark): https://return42.github.io/searx/dev/contribution_guide.html#code Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-24doc(dev): add remarks about creating good commits (messages)Markus Heiser
preview (don't bookmark): https://return42.github.io/searx/dev/contribution_guide.html#code Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-23doc: reST-primer -- imrpove desription of definition listsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-22doc: add plugin section to admin section (template)Markus Heiser
- Plugins configured at built time (defaults) Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-22doc: CSS - fix alignment of code block in figure blocksMarkus Heiser
BTW: minor profread of reST.rst Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-22doc: add 'Architecture' article to admin sectionMarkus Heiser
Herein we add some hints and suggestions about typical architectures of searx infrastructures. We start with a contribution from @dalf - https://github.com/asciimoo/searx/pull/1776#issuecomment-567917320 thanks @dalf !! Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-21doc: add reST templating // incl. generic engine tabeMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-20docs: reST-primer describe table markup (WIP)Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-20docs: reST-primer continued proofreading (WIP)Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-20docs: reST-primer first proofreading (WIP)Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-20doc: reST primer -- describe admonitions & customize their CSSMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-19doc: add content to reST primer (WIP) // linuxdocMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-19doc: add reST primer (inital / WIP)Markus Heiser
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-18edoc: -- makefile.rst fix typo and add extlinks['man']Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-18doc: describe Makefile targetsMarkus Heiser
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-13doc: add note about docs-clean targetMarkus Heiser
BTW: fix some typos Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-13doc: document the new reST & gh-pages workflowMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-12doc: moved reST sources in the right folder (much clearer)Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-12doc: proofread of the all reST sources (no content change)Markus Heiser
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-12doc: installation.rst improve reST markupMarkus Heiser
- 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-12doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinxMarkus Heiser
- 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-10-23add post about introducing offline enginesNoémi Ványi
2018-11-29Merge pull request #1389 from bourrel/patch-1pofilo
Update quickstart.rst
2018-10-21Formatting...tmikaeld
2018-10-21Added missing symlink instructiontmikaeld
2018-08-30Update quickstart.rstLéo Bourrel
Rename `build_grunt` to `grunt_build` as in manage.sh
2018-01-17change python-pybabel to python-babel in package requirementsNoémi Ványi
Closes #1147
2017-10-23update search api with params and description on syntaxNoémi Ványi
2017-07-09add format param to search apiNoémi Ványi
2017-06-12various mods: uwsgi setup and version update ++ py3 img src fix ++ new ↵Adam Tauber
sphinx version - closes #939
2017-03-18rewrite Translation pageNoémi Ványi
2016-11-20installation: nginx mod to sites-enabledNoémi Ványi
2016-11-05engine overview fix torrent tableNoémi Ványi
2016-11-04docs: fix typos based on #653Noémi Ványi
2016-09-10add possible values of time_range paramNoemi Vanyi
2016-09-06add new search parameter time_rangeNoémi Ványi
2016-07-15simplify index pageNoemi Vanyi
2016-07-09better API docs && more features in listNoemi Vanyi
2016-04-21add reverse proxy configurationNoemi Vanyi
2016-04-21update install docs on reverse proxyNoemi Vanyi
2016-04-21add dev tips to quickstartNoemi Vanyi
2016-02-01add development quickstartNoemi Vanyi
2016-01-21[fix] little typoThomas Pointhuber
2016-01-21[enh] improve translation documentationThomas Pointhuber
generated by cgit v1.2.3 (git 2.25.1) at 2026-03-04 03:24:41 +0000