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>
5 years ago
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>
5 years ago
Markus Heiser
62505f8982
docs(dev): add refs to to gitmoji and Semantic PR in contrib section
...
preview (don't bookmark):
https://return42.github.io/searx/dev/contribution_guide.html#code
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
4ca8b69c81
doc(dev): add remarks about creating good commits (messages)
...
preview (don't bookmark):
https://return42.github.io/searx/dev/contribution_guide.html#code
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
c8645d6e37
doc: reST-primer -- imrpove desription of definition lists
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
90174e215c
doc: add plugin section to admin section (template)
...
- Plugins configured at built time (defaults)
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
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>
5 years ago
Markus Heiser
aa3b0265e7
doc: add 'Architecture' article to admin section
...
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>
5 years ago
Markus Heiser
5bdca1a5bf
doc: improved HTML table layout (CSS)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
d1154202bc
doc: add reST templating // incl. generic engine tabe
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
c2b9aa0c2f
docs: reST-primer describe table markup (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
b201f84595
docs: reST-primer continued proofreading (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
ae7cb5937e
docs: reST-primer first proofreading (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
b82f61f704
doc: reST primer -- describe admonitions & customize their CSS
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
e1566e68aa
doc: add content to reST primer (WIP) // linuxdoc
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
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>
5 years ago
Markus Heiser
2b4526916d
edoc: -- makefile.rst fix typo and add extlinks['man']
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
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>
5 years ago
Markus Heiser
fcd7f4cd12
doc: add note about docs-clean target
...
BTW: fix some typos
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
e4e578e8a9
doc: theme - make sidebar less eye-catching
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
97b86fd184
doc: document the new reST & gh-pages workflow
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
04eeeb53a1
doc: moved reST sources in the right folder (much clearer)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
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>
5 years ago
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>
5 years ago
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>
5 years ago
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>
5 years ago
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>
5 years ago
Noémi Ványi
021e1da4c9
add post about introducing offline engines
5 years ago
pofilo
c1ccb25d56
Merge pull request #1389 from bourrel/patch-1
...
Update quickstart.rst
6 years ago
tmikaeld
77494166d2
Formatting...
6 years ago
tmikaeld
10ebe8cec9
Added missing symlink instruction
6 years ago
Léo Bourrel
94af140318
Update quickstart.rst
...
Rename `build_grunt` to `grunt_build` as in manage.sh
6 years ago
Noémi Ványi
20e85275cb
remove Gratipay and Flattr from sidebar
7 years ago
Noémi Ványi
2134c7c693
change python-pybabel to python-babel in package requirements
...
Closes #1147
7 years ago
Noémi Ványi
07ef4a3e4a
update search api with params and description on syntax
7 years ago
Noémi Ványi
979dd3d96c
blog: add post about searx-admin
7 years ago
Adam Tauber
6cc9f56949
[enh] add morty documentation
7 years ago
Noémi Ványi
74d8ed284d
add format param to search api
7 years ago
Adam Tauber
b92631bf8c
various mods: uwsgi setup and version update ++ py3 img src fix ++ new sphinx version - closes #939
7 years ago
Noémi Ványi
93e6258463
add first blog entry on python3 support
8 years ago
James Coleman
b8f5c75374
Corrected spelling of ads in user/own-instance.html
8 years ago
Noémi Ványi
1bd51c6de2
rewrite Translation page
8 years ago
Noémi Ványi
e43e5af207
bump searx version to 0.11.0
8 years ago
Noémi Ványi
6ecd8e3bd7
installation: nginx mod to sites-enabled
8 years ago
Noémi Ványi
d0d2d18a4d
fix typos in own instance page
8 years ago
Noémi Ványi
50f25193c1
engine overview fix torrent table
8 years ago
Noémi Ványi
f55eea083f
generated files of parent
8 years ago
Noémi Ványi
31ea4280bf
"why use a personal instance?" page
8 years ago
Noémi Ványi
ee18ad780e
conf: bump searx version to 0.10.0
8 years ago
Noémi Ványi
c2cf46092e
docs: fix typos based on #653
8 years ago
Noémi Ványi
dca4d276a4
add sample config of filtron
8 years ago
Noemi Vanyi
daf736f1dd
add possible values of time_range param
8 years ago
Noémi Ványi
013139b036
add embedded search to docs
8 years ago
Noémi Ványi
6d99db7af3
add new search parameter time_range
8 years ago
Noemi Vanyi
9e135f9fab
simplify index page
8 years ago
Noemi Vanyi
521f398709
disable breaking "searx" into multiple lines
8 years ago
Noemi Vanyi
2ad8715b32
better API docs && more features in list
8 years ago
Noemi Vanyi
ffcceed517
version bump to 0.9.0 && year to 2016
8 years ago
Noemi Vanyi
b40d7a2b36
add reverse proxy configuration
9 years ago
Noemi Vanyi
2430baa1fd
update install docs on reverse proxy
9 years ago
Noemi Vanyi
9c56154cfe
add dev tips to quickstart
9 years ago
Noemi Vanyi
016ab5c1e8
add development quickstart
9 years ago
Thomas Pointhuber
cf9bd14a7d
[fix] little typo
9 years ago
Thomas Pointhuber
fb62d01194
[enh] improve translation documentation
9 years ago
Noemi Vanyi
08d26609a5
update & fix install guide after install refactor
9 years ago
Noemi Vanyi
3b06814192
[doc] rewrite contribution guide
9 years ago
Noemi Vanyi
240802003e
[doc] fix small mistakes in engine overview
9 years ago
Noemi Vanyi
ae69a58089
[doc] grammar & format fixes in engine overview
9 years ago
Adam Tauber
11d6d80d88
[doc] engines overview added
9 years ago
Adam Tauber
1d6597b407
[enh] initial structure
9 years ago