summaryrefslogtreecommitdiff
path: root/docs/conf.py
AgeCommit message (Collapse)Author
2020-11-04Feature/standalone searx update (#1591)rachmadani haryono
* chg: dev: update standalone_searx parent d8a5df721b33dd8a7cc9e21dba4060f21d629f69 author rachmadaniHaryono <foreturiga@gmail.com> 1603896594 +0800 committer rachmadaniHaryono <foreturiga@gmail.com> 1603896619 +0800 chg: dev: debug engine_shortcuts chg: dev: only initilize if engine is given chg: dev: split main chg: dev: standalone_searx chg: dev: update standalone_searx chg: doc: remove unnecessary log chg: test: differentiate travis chg: test: disable shortcut chg: test: use default engine settings fix: dev: category choices fix: dev: duplicate engine shortcut fix: dev: travis python3 fix: test: use empty string as shortcut fix: test: apkm fix: test: engine shortcut fix: test: mypy fix: test: parameter fix: test: pep8 fix: test: py2 compatibilities fix: test: searx settings fix: test: travis engines new: dev: deduplicate engine new: dev: main receive engines parameter new: dev: parse_argument accept engines parameter new: dev: split search query from get_result func new: test: basic result case Suggestions: use RawTextQuery to make the suggestions URLs. Update all themes accordingly. * new: doc: searx import and init * chg: dev: parse_argument - doc - run on __main__ - simple parse_args * chg: doc: module * chg: dev: import section - remove unused python path modification - new required package * chg: dev: script run - parse_argument func return directly parsed results - main func return dict instead json text - dump directly on sys.stdout.write * chg: dev: get_search_query and get_search_query func * chg: dev: main func - move inner function outside - return dict instead of json text * new: dev: add utils to doc sys path * new: doc: standalone_searx * fix: doc: run script * chg: dev: mypy type hint * chg: dev: SearchQuery don't have attr engines * chg: dev: reset engines __init__ * chg: test: unit test update * chg: dev: pylint and flake8 * new: test: standalone_searx * chg: dev: main func and doc * chg: dev: import and type hint * new: dev: main func - remove get_result func - single func which just translate dict * chg: test: put mypy on dev requirement * chg: doc: update * new: doc: add standalone_searx module member * chg: doc: shell command line * chg: dev: remove mypy * chg: doc: module docstring
2020-10-01[fix] revert PR #2232 and #2230Alexandre Flament
2020-09-30[fix] Sphinx 3.2.1 build: call searx.engines.initialize_enginesAlexandre Flament
Fix admin/engines.html Fix #2230
2020-09-30Merge pull request #2230 from dalf/fix-sphinx-buildAlexandre Flament
[fix] Sphinx 3.2.1 build: add missing "engines" variable in the jinja context
2020-09-29[fix] Sphinx 3.2.1 build: add missing "engines" variable in the jinja contextAlexandre Flament
Fix the admin/engines.html page
2020-09-28[fix] migration from github.com/asciimoo/searx to github.com/searx/searx : ↵Alexandre Flament
fix URLs
2020-06-18[enh] add 'kernel-include' reST-directiveMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-29build environment: add GIT_BRANCH variableMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-29tooling box: simplify build enviromentsMarkus Heiser
- no more need for a .config.mk - docs: use searx.brands environment - searx.sh, filtron.sh & morty.sh are sourcing utils/brand.env Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-21docs: building (PDF) books / build user bookMarkus Heiser
BTW: cleaned up Makefile target help Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-03docs: generic documentation get templatingMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-02-23Merge branch 'master' of https://github.com/asciimoo/searx into filtronMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-02-20docs: fix dead Searx-instance links to https://searx.spaceMarkus Heiser
Related to #1853 / BTW update year of copyright note Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-02-17Merge branch 'master' of https://github.com/asciimoo/searx into filtronMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-02-14[mod] move public instance list to https://searx.spaceDalf
2020-02-04docs: fix extlink 'origin' to use GIT_BRANCH envMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-01-11docs: add Sphinx-doc extension sphinxcontrib.programoutputMarkus Heiser
- https://github.com/NextThought/sphinxcontrib-programoutput Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-01-06docs: move wiki/Searx-instances from wiki to docsMarkus Heiser
fix project link in conf.py Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-28docs(admin): add article 'Buildhosts' with system requirementsMarkus 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-21doc: add reST templating // incl. generic engine tabeMarkus 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: document the new reST & gh-pages workflowMarkus 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: 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-12-12doc: use customized pocoo theme (pallets-sphinx-themes)Markus Heiser
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-10-23add post about introducing offline enginesNoé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-18bump searx version to 0.11.0Noémi Ványi
2016-11-04conf: bump searx version to 0.10.0Noémi Ványi
2016-07-09version bump to 0.9.0 && year to 2016Noemi Vanyi
2015-11-17[enh] initial structureAdam Tauber