27bb55ab07
[brand] SearXNG - docs html_theme = "searxng"
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
3 years ago
3e5057405a
[mod] doc - html_logo = themes/simple/src/svg/searxng-wordmark.svg
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
3 years ago
2cc2406859
[mod] doc - in sidebar, add links to the reST sources
...
Offer links to the reST sources (aka) html_show_sourcelink [1]. Links to the
reST source are sometimes very helpful, especially in our resT-Primer [2] :)
[1] https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_show_sourcelink
[2] https://searxng.github.io/searxng/dev/reST.html
Related-to: https://github.com/pallets/pallets-sphinx-themes/issues/32
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
3 years ago
dc1442a2d1
[mod] Tools to install and maintain NVM versions manager for Node.js
...
[1] https://github.com/nvm-sh/nvm
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
3 years ago
a9fc4885f2
[brand] SearXNG - bash env SEARXNG_URL
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
3 years ago
ecb7e73e03
[brand] docs - normalize project name to SearXNG
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
3 years ago
4833d85e2e
[doc] update copyright notice and HTML title
3 years ago
4b43775c91
version based on the git repository
...
This commit remove the need to update the brand for GIT_URL and GIT_BRANCH:
there are read from the git repository.
It is possible to call python -m searx.version freeze to freeze the current version.
Useful when the code is installed outside git (distro package, docker, etc...)
3 years ago
3e50e8de3e
[mod] drop usage of the searx.brand namespace (python procs)
...
Added function searx.get_setting(name, default=_unset):
Returns the value to which ``name`` point. If there is no such name in the
settings and the ``default`` is unset, a KeyError exception is raised.
In all the python processes ..
- make docs
- make buildenv
- make install (setup.py)
the usage of the 'brand.*' name space is replaced by 'searx.get_setting'
function.
- brand.SEARX_URL --> get_setting('server.base_url')
- brand.GIT_URL --> get_setting('brand.git_url')
- brand.GIT_BRANCH' --> get_setting('server.base_url')
- brand.ISSUE_URL --> get_setting('brand.issue_url')
- brand.DOCS_URL --> get_setting('brand.docs_url')
- brand.PUBLIC_INSTANCES --> get_setting('brand.public_instances')
- brand.CONTACT_URL --> get_setting('general.contact_url', '')
- brand.WIKI_URL --> get_setting('brand.wiki_url')
- brand.TWITTER_URL --> get_setting('brand.twitter_url', '')
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
3 years ago
97d801e8a0
[fix] docs/conf.py - docutils docs moved to docutils.sourceforge.io
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
3 years ago
dddf3e2be2
[mod] "make docs" doesn't initialize the engines
...
avoid external HTTP requests with "make docs"
3 years ago
15de8708b7
[docs] highlight source code linked from *automodule* content
...
sphinx.ext.viewcode won't highlight when 'highlight_language' [1] is set to
string 'none' [2]
[1] https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html
[2] https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-highlight_language
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
3 years ago
28b25185c5
[brand] searxng -- fix links to issue tracker & WEB-GUI
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
3 years ago
d0e371f474
[mod] replace makefile boilerplate by 'manage' script
...
Replaces the make targets with the bash scripts
Signed-off-by: Markus Heiser <markus@darmarit.de>
3 years ago
9485179064
[mod] move brand options from Makefile to settings.yml
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
3 years ago
eb1b5289d5
[mod] documentation: change the jinja context doesn't depend on searx.webapp
...
Before this commit, in the documentation, the jinja context is 'webapp' and contains
the global variable in the searx.webapp module.
This commit changes this to include only the mandatory variables to build the
documentation.
3 years ago
38d32337e7
[mod] documentations & comments: update http://* URL to https://*.
...
About http://lesscss.org see https://github.com/less/less-docs/issues/520
4 years ago
c03e4c86bc
Feature/standalone searx update ( #1591 )
...
* 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
4 years ago
2cafc5462d
[fix] revert PR #2232 and #2230
4 years ago
9a856083df
[fix] Sphinx 3.2.1 build: call searx.engines.initialize_engines
...
Fix admin/engines.html
Fix #2230
4 years ago
6c6985aaf8
Merge pull request #2230 from dalf/fix-sphinx-build
...
[fix] Sphinx 3.2.1 build: add missing "engines" variable in the jinja context
4 years ago
6d56c754a7
[fix] Sphinx 3.2.1 build: add missing "engines" variable in the jinja context
...
Fix the admin/engines.html page
4 years ago
f204e4903d
[fix] migration from github.com/asciimoo/searx to github.com/searx/searx : fix URLs
4 years ago
aa5f947157
[enh] add 'kernel-include' reST-directive
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
4 years ago
0742c2504d
build environment: add GIT_BRANCH variable
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
4 years ago
7b4cf2eb48
tooling box: simplify build enviroments
...
- 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>
4 years ago
2d956696e9
docs: building (PDF) books / build user book
...
BTW: cleaned up Makefile target help
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
4 years ago
f25da6070e
docs: generic documentation get templating
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
4 years ago
4d67164918
Merge branch 'master' of https://github.com/asciimoo/searx into filtron
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
4 years ago
a9d184473f
docs: fix dead Searx-instance links to https://searx.space
...
Related to #1853 / BTW update year of copyright note
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
4 years ago
63b0ba701f
Merge branch 'master' of https://github.com/asciimoo/searx into filtron
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
4 years ago
88f9ac58f4
[mod] move public instance list to https://searx.space
4 years ago
a5eefea61d
docs: fix extlink 'origin' to use GIT_BRANCH env
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
4 years ago
876988a34f
docs: add Sphinx-doc extension sphinxcontrib.programoutput
...
- https://github.com/NextThought/sphinxcontrib-programoutput
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
4 years ago
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>
4 years ago
d1892b2112
docs(admin): add article 'Buildhosts' with system requirements
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
4 years ago
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>
4 years ago
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>
4 years ago
d1154202bc
doc: add reST templating // incl. generic engine tabe
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
e1566e68aa
doc: add content to reST primer (WIP) // linuxdoc
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
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
2b4526916d
edoc: -- makefile.rst fix typo and add extlinks['man']
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
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
97b86fd184
doc: document the new reST & gh-pages workflow
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
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
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
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
021e1da4c9
add post about introducing offline engines
5 years ago
b92631bf8c
various mods: uwsgi setup and version update ++ py3 img src fix ++ new sphinx version - closes #939
7 years ago
e43e5af207
bump searx version to 0.11.0
7 years ago
Markus Heiser
Alexandre Flament
rachmadani haryono
Noémi Ványi
Adam Tauber