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
22d05b3e59
Merge pull request #1791 from return42/add-docs
...
misc docs
2020-01-06 14:28:24 +00:00
Markus Heiser
86b5163641
docs: move wiki/Searx-instances from wiki to docs
...
fix project link in conf.py
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-06 15:06:36 +01:00
Markus Heiser
f521a279ac
Merge branch 'master' of https://github.com/asciimoo/searx into add-docs
2020-01-06 14:32:34 +01:00
Markus Heiser
0f4f0e517e
docs(user): move wiki/Searx-instances from wiki to docs
...
fixed some reST markups
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-06 14:31:18 +01:00
Markus Heiser
a3bbf95ad5
Merge pull request #1781 from finn0/bug/oscar-theme
...
Oscar: move info box at top of the page
2020-01-06 08:16:22 +00:00
Markus Heiser
1d86d0054f
Merge branch 'master' into bug/oscar-theme
2020-01-06 08:05:29 +00:00
Markus Heiser
3bb97fcb84
docs(user): public instances, fix Searxes@Danwin entry
...
fixes: https://github.com/asciimoo/searx/issues/1770
This is not Searx at all. This is Meta-Searx with other engines.
See https://github.com/asciimoo/searx/issues/1770#issuecomment-570776655
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-05 10:02:42 +01:00
Markus Heiser
200c3a31f5
docs(user): move wiki/Searx-instances from wiki to docs (WIP)
...
Move wiki entry https://github.com/asciimoo/searx/wiki/Searx-instances
into user section of the docs (#1785 ).
links has been ported from markdown to reST by::
regexpr: \[([^\]]*)\]\(([^)]*)\)
substitution: `\1 <\2>`__
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-04 18:26:04 +01:00
Markus Heiser
7347d9b508
docs(user): move wiki/Searx-instances from wiki to docs
...
Move wiki entry https://github.com/asciimoo/searx/wiki/Searx-instances
into user section of the docs (#1785 ).
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2020-01-04 17:09:11 +01:00
Markus Heiser
51b9295b84
Merge branch 'master' of https://github.com/asciimoo/searx into add-docs
2020-01-03 14:30:53 +01:00
Markus Heiser
2a7855854b
Merge pull request #1623 from ypid/fix/nginx-subdir-hosting
...
Fix Nginx subdir URL install docs which allowed download of settings.yml
2019-12-31 16:26:21 +01:00
Markus Heiser
f602cb8e4d
docs(admin): moved settings description from wiki to docs
...
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-30 21:56:09 +01:00
Markus Heiser
f9be534b2a
docs(dev): fix minor markup typos
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-30 21:55:15 +01:00
Markus Heiser
10997a01e0
docs(admin): add weight & disabled cols to engine table
...
BTW: remove internal suspend_end_time
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-30 20:29:37 +01:00
Markus Heiser
754a10c1c1
Merge pull request #1661 from 0xhtml/fix-engine-spotify
...
Fix engine spotify
As you can read here https://developer.spotify.com/documentation/web-api/#authentication all requests to the spotify api require authentication. You can not test the api without credentials.
2019-12-30 07:44:31 +01:00
Markus Heiser
36e72a4619
Merge branch 'master' into fix-engine-spotify
2019-12-29 09:47:06 +01:00
Markus Heiser
f6d66c0f6f
Merge pull request #1776 from return42/makefile-doc
...
doc: describe Makefile targets & add reST primer
2019-12-28 13:55:20 +01:00
Markus Heiser
b91e07bbf1
docs(css): render HTML rst-example slightly more discreet
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-28 01:26:24 +01:00
Markus Heiser
d1892b2112
docs(admin): add article 'Buildhosts' with system requirements
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-28 01:25:16 +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
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 >
2019-12-25 09:57:21 +01:00
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 >
2019-12-24 18:48:23 +01:00
Markus Heiser
5eb8cf4ebb
Merge branch 'master' of https://github.com/asciimoo/searx into makefile-doc
2019-12-24 18:00:24 +01:00
Markus Heiser
a52a638ba8
Merge pull request #1701 from CaffeinatedTech/patch-1
...
Update README.rst
for the future: please select meaningful commit messages. Here is a good summarize how a useful commit messages looks like: https://www.conventionalcommits.org/en/v1.0.0-beta.2/#summary
Further read: https://wiki.openstack.org/wiki/GitCommitMessages#Information_in_commit_messages
2019-12-24 17:56:24 +01:00
Markus Heiser
ecb054a7a0
Merge branch 'master' into patch-1
2019-12-24 17:45:13 +01:00
Markus Heiser
5a0a66e9bc
Merge pull request #1615 from Nachtalb/ne/fix-infinite_scroll-with-vim_bindings
...
Fix not jumping to results loaded by infinite scroll
2019-12-24 17:34:33 +01:00
Markus Heiser
38dad2e8e3
Merge branch 'master' into ne/fix-infinite_scroll-with-vim_bindings
2019-12-24 15:42:05 +01:00
Markus Heiser
a395fb4a8d
Merge pull request #1694 from finn0/libgen
...
Fix broken Library Gensis Engine
2019-12-24 13:37:29 +01:00
Markus Heiser
fb668e2075
Merge branch 'master' into libgen
2019-12-24 13:33:07 +01:00
Markus Heiser
46dd51afad
Merge branch 'master' into makefile-doc
2019-12-24 12:27:36 +01:00
Markus Heiser
6d232e9b69
Merge pull request #1787 from finn0/fix/infobox
...
[Fix] oscar: no HTML escaping prior to output
2019-12-24 11:37:33 +01:00
Markus Heiser
70f7142824
Merge branch 'master' into bug/oscar-theme
2019-12-23 18:47:23 +01:00
Markus Heiser
07c8ca87e6
Merge branch 'master' into makefile-doc
2019-12-23 13:58:53 +00:00
Markus Heiser
3e14bf4d27
Merge pull request #1686 from MarcAbonce/wiki_infobox_fixes
...
Infobox fixes
2019-12-23 12:31:31 +00: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
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
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
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
Markus Heiser
a3b5f3230c
theme: oscar - remove dust (comes from PR #1671 implementation)
...
was inadvertently included in the commit [1]
[1] https://github.com/asciimoo/searx/commit/f34ac58752b3857468d01c79d7bc3409e8b03fe3#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
Markus Heiser
7beb49b1fb
Merge branch 'master' into boilerplate
2019-12-10 13:10:51 +00:00
Markus Heiser
56b7e05721
themes: remove CR from newlines
...
Adding a CR in some files and in others not, is a good starting point for a
DOS+Unix mess we all have already seen in many projects.
Patch fixes all files matching (even those comming from grunt's build)::
find ./searx -exec file {} \; | grep CR
BTW: Same with mixing TAB and SPACE indent styles in one and the same file. So
if sources are tuched here in this patch, its also fixed.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-08 15:33:46 +01:00
Markus Heiser
1b90e1403b
Merge branch 'master' of https://github.com/asciimoo/searx into boilerplate
2019-12-03 11:38:52 +01:00
Markus Heiser
30ad0c666d
duckduckgo_definitions: remove the debug message
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-12-02 14:26:11 +01:00
Markus Heiser
b6d9f5aa71
[fix] duckduckgo_definition issues reported by 'manage.sh test'
...
Fix this error while travis build::
/home/travis/build/asciimoo/searx/searx/engines/duckduckgo_definitions.py:21:44: E225 missing whitespace around operator
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-11-29 19:59:35 +01:00
Markus Heiser
4998e9ec85
[fix] duckduckgo_definitions - where 'AnswerType' is 'calc'
...
Do not try to get text when 'AnswerType' is 'calc'.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-11-29 19:20:14 +01:00
Markus Heiser
2aa95c16e3
[fix] soundcloud: URLs of JS sources has been moved
...
The client_id is found under (new) URL:
https://a-v2.sndcdn.com/assets/49-a0c01933-3.js
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-11-29 15:05:36 +01:00
Markus Heiser
52450fd08a
.dir-locals.el: add some comments about jedi & EPC
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-11-29 13:15:15 +01:00
Markus Heiser
147f40c386
Merge branch 'master' of https://github.com/asciimoo/searx into boilerplate
2019-11-28 20:38:29 +01:00
Markus Heiser
62a4b7443f
boilerplate: add .dir-locals.el with emacs python enviroment
...
The .dir-locals.el set the project's python enviroment for the emacs tasks like
flycheck or jedi. The py-environment has to be next to <repo>/.dir-locals.el::
./local/py3
To setup such an environment build target 'pyenv' or 'pyenvinstall'::
$ make pyenvinstall
TL;DR
Alternatively create the virtualenv, source it and install jedi + epc
(required by `emacs-jedi <https://tkf.github.io/emacs-jedi >`_)::
$ virtualenv --python=python3 "--no-site-packages" ./local/py3
...
$ source ./local/py3/bin/activate
(py3)$ # now install into the activated 'py3' environment ..
(py3)$ pip install jedi epc
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-11-28 20:08:44 +01:00
Markus Heiser
796197db2d
boilerplate: add pylint / WIP: balance linting with pylint
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-11-28 20:07:10 +01:00
Markus Heiser
7e572a2453
Makefile: add test.pep8 test.unit test.robot (from manage.sh)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-11-28 20:05:29 +01:00
Markus Heiser
b55a8004ed
boilerplate: add inital Makefile with run & install targets
...
Add *Makefile* boilerplate useful for python projects. All python tasks are
using a virtualenv from ./local/py3
$ make help
run - run developer instance
install - developer install (./local)
uninstall - uninstall (./local)
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-11-28 19:54:57 +01:00
Markus Heiser
a56c56ead3
seatup.py: fix [dev_]requirements and open file with context
...
setup(..) named arguments 'install_requires' and 'extras_require' need lists
arguments, the <map object> is ignored when installing extra environment
'test'::
pip install -e .\[test\]
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de >
2019-11-28 19:22:03 +01:00