Markus Heiser
d3e4e81faf
makefile.sphinx: fix gh-pages / pull before add commits
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-22 23:28:07 +01:00
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>
2019-12-22 23:26:06 +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
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>
2019-12-22 14:05:33 +01:00
Markus Heiser
5bdca1a5bf
doc: improved HTML table layout (CSS)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-22 11:46:03 +01:00
Markus Heiser
aea4667fbc
Merge branch 'master' of https://github.com/asciimoo/searx into makefile-doc
2019-12-22 10:12:33 +01:00
Adam Tauber
34ad3d6b34
[enh] display error message if gigablast extra param expired
2019-12-21 21:25:50 +01:00
Adam Tauber
52ccaa7acc
[mod] remove useless engine unit tests
...
These tests are not able to detect engine errors if the upstream
site changes.
2019-12-21 21:15:09 +01:00
Adam Tauber
fc457569f7
[fix] pep8
2019-12-21 21:13:43 +01:00
Adam Tauber
00512e36c1
[fix] handle empty response from wikipedia engine - closes #1114
2019-12-21 21:01:08 +01:00
Adam Tauber
f8713512be
[fix] convert byte query to string in osm engine - fixes #1220
2019-12-21 20:56:38 +01:00
Adam Tauber
e5305f886c
[fix] fetch extra search param of gigablast - fixes #1293
2019-12-21 20:51:30 +01:00
Adam Tauber
8850036ded
[fix] add explicit useragent header to requests - closes #1459
2019-12-21 20:25:39 +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
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
Adam Tauber
da56bda265
Merge pull request #1457 from hobbestigrou/force_upgrade_requirements
...
[Scripts] Force upgrade requirements.
2019-12-17 13:55:13 +00:00
Adam Tauber
fb6ff5afcb
Merge pull request #1767 from return42/docs
...
move reST source from gh-pages to master
2019-12-16 11:41:49 +00:00
Markus Heiser
02d5173fb2
Makefile: remove trailing '/' from DOCS_URL
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-13 16:08:34 +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
121f696460
Makefile: gh-pages: keep history of gh-branch intact (don't drop)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-13 12:58:46 +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
0011890043
gh-pages - build docs & deploy on gh-pages branch
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-12 14:15:41 +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
Markus Heiser
ef85943e06
Makefile: add documentation build targets docs & docs-live
...
BTW:
- add build & dist folder to .gitignore
- justify indentation of build messages (makefile.python)
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-12 12:10:32 +01:00
Markus Heiser
bb2b9b8da4
utils: add makefile.sphinx to the boilerplate
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-12 11:48:51 +01:00
Markus Heiser
49e8dd1e0d
doc: move patches from /doc folder of branch gh-pages to master
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-12 11:19:26 +01:00
Adam Tauber
3f93fe04d8
Merge pull request #1752 from MarcAbonce/user-agents-update
...
User agents update
2019-12-11 15:45:02 +00:00
Adam Tauber
b0177847f8
Merge pull request #1763 from return42/dos2unix
...
themes: remove CR from newlines
2019-12-11 15:43:38 +00:00
Markus Heiser
a3b5f3230c
theme: oscar - remove dust (comes from PR #1671 implementation)
...
was inadvertently included in the commit [1]
[1] f34ac58752 (diff-0243d1c24e9981002156cc87cc10bd53R103)
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-10 18:33:36 +01:00
Markus Heiser
f373169c84
theme: oscar - add accesskey to input tags
...
l - language field
s - search field
t - time range field
The way to activate the accesskey depends on the browser and its platform [1]
[1] https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/accesskey
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-10 18:20:51 +01:00
Markus Heiser
57c6fa6e63
theme: oscar - fix auto-submit on language seletion
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-10 18:16:45 +01:00
Markus Heiser
2a5c39e33c
theme: oscar - tidy up trailing whitespaces and tab usage
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-10 18:10:33 +01:00
Markus Heiser
9988cdcbc5
Merge branch 'master' of https://github.com/asciimoo/searx into dos2unix
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-10 17:35:23 +01:00
Markus Heiser
50e1fcaa5e
Merge pull request #1671 from dalf/tidy-oscar
...
[mod] tidy oscar HTML output
2019-12-10 16:02:54 +00:00
Markus Heiser
7fbb15e050
Merge branch 'master' into tidy-oscar
2019-12-10 15:41:06 +00:00
Adam Tauber
f7a0510ac0
Merge pull request #1756 from return42/boilerplate
...
RFC: Makefile based boilerplate for python projects
2019-12-10 15:14:18 +00:00
Markus Heiser
7beb49b1fb
Merge branch 'master' into boilerplate
2019-12-10 13:10:51 +00:00