summaryrefslogtreecommitdiff
path: root/docs/conf.py
AgeCommit message (Collapse)Author
2022-07-30[doc] update documentation of the installation proceduresMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-05[fix] Sphinx 5.x: will warn about missleading extlink definitionsMarkus Heiser
This patch fixes the WARNING messages that pops up since Sphinx 5.x: WARNING: extlinks: Sphinx-6.0 will require a caption string to contain exactly one '%s' and all other '%' need to be escaped as '%%'. [1] https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-06-22[doc] intersphinx: fix https://python-babel.github.io/flask-babelMarkus Heiser
The URL https://flask-babel.tkte.ch/ is no longer valid [1]. [1] https://github.com/python-babel/flask-babel/commit/0847cc6284 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-06-16Add privacypolicy_url optionsamsaptidev
2022-06-14[doc] fix some leftovers from ad964562cMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-05-30[mod] collection of redis functions and lua scripts (initial)Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-04-06[mod] replace Markdown parser mistletoe by markdown-it-pyMarkus Heiser
There are several reasons why we should prefer markdown-it-py over mistletoe: - Get identical rendering results in SearXNG's `/info` pages and the SearXNG's project documentation which is build by Sphinx-doc. In the Sphinx-doc we use the MyST parser to render Markdown and the MyST parser itself is built on top of the markdown-it-py package. - markdown-it-py has a typographer that supports *replacements* and *smartquotes* (e.g. em-dash, copyright, ellipsis, ...) [1] - markdown-it-py is much more flexible compared to mistletoe [2] - markdown-it-py is the fastest CommonMark compliant parser in python [3] [1] https://markdown-it-py.readthedocs.io/en/latest/using.html#typographic-components [2] https://markdown-it-py.readthedocs.io/en/latest/plugins.html [3] https://markdown-it-py.readthedocs.io/en/latest/other.html#performance Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-03-22[doc] add sphinx-notfound-pageMarkus Heiser
Closes: https://github.com/searxng/searxng/issues/703 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-03-12[interim fix] of sphinx-tabs and sphinx-jinjaMarkus Heiser
The myst-parser requires >= docutils v.0.17 what ends in a dependency hell where plugins sphinx-tabs and sphinx-jinja we use are involved. This patch can be reverted when [2], [3], [4] are solved and new release is available / see [1]. [1] https://github.com/searxng/searxng/pull/954 [2] https://github.com/executablebooks/sphinx-tabs/issues/152 [3] https://github.com/executablebooks/sphinx-tabs/pull/153 [4] https://github.com/executablebooks/sphinx-tabs/pull/154 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-03-12[mod] replace /help by /info pages and include pages in project docsMarkus Heiser
This patch implements a bolierplate to share content from info-pages of the SearXNG instance (URL /info) with the project documentation (path /docs/user). The info pages are using Markdown (CommonMark), to include them in the project documentation (reST) the myst-parser [1] is used in the Sphinx-doc build chain. If base_url is known (defined in settings.yml) links to the instance are also inserted into the project documentation:: searxng_extra/docs_prebuild [1] https://www.sphinx-doc.org/en/master/usage/markdown.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-01-27[fix] docs - don't add plugins twiceMarkus Heiser
The PluginStore is already initalized when the application is initalized searx.plugins.initialize(application) BTW: remove unneeded Flask import Closes: https://github.com/searxng/searxng/issues/828 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-01-07[fix] Documentation of the builtin pluginsMarkus Heiser
Closes: https://github.com/searxng/searxng/issues/637 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-01-05[mod] move group_engines_in_tab to searx.webutilsMartin Fischer
2022-01-03[enh] introduce categories_as_tabsMartin Fischer
Previously all categories were displayed as search engine tabs. This commit changes that so that only the categories listed under categories_as_tabs in settings.yml are displayed. This lets us introduce more categories without cluttering up the UI. Categories not displayed as tabs can still be searched with !bangs.
2022-01-03[doc] engine tables: show engines in all categoriesMartin Fischer
Previously the documentation grouped the engines by their first category so e.g. YouTube and Invidious were only shown in the in the videos section but not in the music section. This commit fixes this by iterating over searx.engines.categories, which also has the added benefit that the sections are now in the same order as the tabs in the user interface.
2022-01-03[doc] engine-table: stop sorting by DisabledMartin Fischer
It's only the default value for disabled it's not that important, since users can easily toggle it anytime in the engine preferences.
2021-12-24[doc] add global TOC to sidebarMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-12-21[doc] engine-table: link module documentation if it existsMartin Fischer
2021-12-21[doc] say how many engines are supported / enabledMartin Fischer
2021-12-21[doc] introduce about.language and sort engines by itMartin Fischer
2021-12-20[doc] engine-table: sort by Disabled and NameMartin Fischer
2021-11-29[mod] themes/simple/img/searxng.svg -> src/brand/searxng.svgMarkus Heiser
* move `searx/static/themes/simple/img/searxng.svg` to `src/brand/searxng.svg` * README.rst can use it without a reference to a theme. * the simple theme can create `searx/static/themes/simple/img/searxng.png` using the svg2png task Suggested-by: @dalf https://github.com/searxng/searxng/pull/561#issuecomment-981747902 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-11-18[brand] SearXNG - docs html_theme = "searxng"Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-11-18[mod] doc - html_logo = themes/simple/src/svg/searxng-wordmark.svgMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-11-18[mod] doc - in sidebar, add links to the reST sourcesMarkus Heiser
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>
2021-11-16[mod] Tools to install and maintain NVM versions manager for Node.jsMarkus Heiser
[1] https://github.com/nvm-sh/nvm Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-10-30[brand] SearXNG - bash env SEARXNG_URLMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-09-13[brand] docs - normalize project name to SearXNGMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-09-10[doc] update copyright notice and HTML titleAlexandre Flament
2021-07-30version based on the git repositoryAlexandre Flament
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...)
2021-07-18[mod] drop usage of the searx.brand namespace (python procs)Markus Heiser
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>
2021-06-04[fix] docs/conf.py - docutils docs moved to docutils.sourceforge.ioMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[mod] "make docs" doesn't initialize the enginesAlexandre Flament
avoid external HTTP requests with "make docs"
2021-06-01[docs] highlight source code linked from *automodule* contentMarkus Heiser
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>
2021-04-25[brand] searxng -- fix links to issue tracker & WEB-GUIMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-04-23[mod] replace makefile boilerplate by 'manage' scriptMarkus Heiser
Replaces the make targets with the bash scripts Signed-off-by: Markus Heiser <markus@darmarit.de>
2021-01-11[mod] move brand options from Makefile to settings.ymlMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-12-27[mod] documentation: change the jinja context doesn't depend on searx.webappAlexandre Flament
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.
2020-12-04[mod] documentations & comments: update http://* URL to https://*.Alexandre Flament
About http://lesscss.org see https://github.com/less/less-docs/issues/520
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>
generated by cgit v1.2.3 (git 2.25.1) at 2026-03-04 11:31:44 +0000