summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2022-07-07Merge pull request #1428 from return42/fix-center_aligmentAlexandre Flament
fix typo and document preference 'center_alignment' in the 'ui' section
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-07-05[fix] sphinx 5.x: add `nav.contents` everywhere that `div.topic` is usedMarkus Heiser
Previously, docutils produced `div.topic` for the contents directive, the latest version produces `nav.contents`. This means that those tables of contents change appearance when switching to docutils 0.18 [1][2]. [1] https://github.com/sphinx-doc/sphinx/pull/10535/commits/5806f0a [2] https://github.com/sphinx-doc/sphinx/issues/10534 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-03[docs] document preference 'center_alignment' in the 'ui' section.Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-02[docs] add documentation about the `general.donation_url:` settingMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-06-29Update docs/donate.rstAlexandre Flament
Co-authored-by: Émilien Devos <contact@emiliendevos.be>
2022-06-29Move donation page to docs.searxng.org and link to it from instancesAlexandre FLAMENT
Close #1378
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-30[theme] peel out oscar from SearXNG developmentMarkus Heiser
This is the first step of removing oscar theme Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-04-22[docs] document the missing server:limiter settingMarkus Heiser
BTW: fix some minor typos in docs/admin/engines/settings.rst 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-26Merge pull request #999 from return42/fix-doc-settings2Alexandre Flament
[docs] document settings.yml: search.languages
2022-03-26Merge pull request #1000 from return42/fix-703Alexandre Flament
[fix] add sphinx-notfound-page
2022-03-26[docs] document settings.yml: search.languagesMarkus Heiser
Requested-by: @dalf https://github.com/searxng/searxng/pull/996#discussion_r830858139 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-03-25[doc] add some documentation about the limiter plugin (and redis)Markus Heiser
Requested-by: https://github.com/searxng/searxng/discussions/993#discussioncomment-2396914 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-21[docs] improve settings.yml documentation (admin/engines/settings)Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-03-20Merge pull request #859 from return42/fix-814Markus Heiser
[mod] add i18n infrastructure for SearXNG message files (searxng.msg)
2022-03-16Sphinx doc: rename "User documentation" to "User Information"Alexandre Flament
2022-03-16[mod] add i18n infrastructure for SearXNG message files (searxng.msg)Markus Heiser
With this patch ``searxng.msg`` files can be added to SearXNG. In ``searxng.msg`` files messages can be defined which are not captured by babel's gettext, like the generic names of the categories or messages that are stored in constants. 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-03-07[docs] move own-instance.rst out of docs/userMartin Fischer
2022-02-04Merge pull request #839 from dalf/docs_searx_utilsMarkus Heiser
[mod] add documentation about searx.utils
2022-02-02[enh] limiter pluginAlexandre Flament
can replace filtron: * rate limite the number of request per IP and per (IP, User-Agent) * block some bots use Redis data stored in Redis never contains the IP addresses, only HMAC using the secret_key Co-authored-by: Markus Heiser <markus.heiser@darmarit.de>
2022-01-29[mod] add documentation about searx.utilsAlexandre Flament
This module is a toolbox for the engines. Is should be documented. In addition, searx/utils.py is checked by pylint.
2022-01-28[mod] tineye - add some documentationMarkus Heiser
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-21[docs] fix some warnings from Sphinx-doc update 4.3.2 to 4.4.0Markus Heiser
With Sphinx-doc update 4.4.0 we get some warnings about links that can be replaced by already defined 'sphinx.ext.extlinks': admin/engines/sql-engines.rst:144: WARNING: hardcoded link 'https://pypi.org/project/mysql-connector-python' could be replaced by an extlink (try using ':pypi:`mysql-connector-python`' instead) docs/admin/installation-switch2ng.rst:10: WARNING: hardcoded link 'https://github.com/searxng/searxng/pull/446#issuecomment-954730358' could be replaced by an extlink (try using ':pull:`446#issuecomment-954730358`' instead) Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-01-18[fix] typo 'test.sh' in the docs/dev/makefile.rst to 'test.shell'Markus Heiser
make test.sh --> make test.shell Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-01-17[docs] Switch from searx to SearXNGMarkus Heiser
Closes: https://github.com/searxng/searxng/issues/450 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-01-12Merge pull request #734 from not-my-profile/search-syntax-docMartin Fischer
Small fixes to Search syntax doc
2022-01-12[doc] Multilingual Search: wrap lines to 80 charactersMarkus Heiser
2022-01-11Merge pull request #686 from return42/lib_redisMarkus Heiser
Add redis DB and connector
2022-01-10[doc] highlight the current page in the sidebarMartin Fischer
2022-01-10[doc] move Multilingual Search from user to admin docsMartin Fischer
settings.yml snippets have no place in the user docs.
2022-01-10[doc] fix outdated settings exampleMartin Fischer
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-06[fix] remove broken ? search operatorMartin Fischer
The ? search operator has been broken for some time and currently only raises the question why it's still there. ## Context ## The query "Paris !images" searches for "Paris" in the "images" category. Once upon a time Searx supported "Paris ?images" to search for "Paris" in the currently enabled categories and the "images" category. The feature makes sense ... the ? syntax does not. We will hopefully introduce a +!images syntax in the future. Fixes #702.
2022-01-06Merge pull request #634 from not-my-profile/powered-byAlexandre Flament
Introduce `categories_as_tabs` & group engines in tabs
2022-01-05Merge pull request #688 from dalf/settings_enable_statsMarkus Heiser
[enh] settings.yml: implement general.enable_metrics
2022-01-05Merge pull request #683 from return42/fix-docMartin Fischer
Document & Pylint scripts in searxng_extra/update
2022-01-05Merge pull request #679 from dalf/brand-searxngAlexandre Flament
searxng.org: update setup.py & settings.yml
2022-01-05[enh] settings.yml: implement general.enable_metricsAlexandre Flament
* allow not to record metrics (response time, etc...) * this commit doesn't change the UI. If the metrics are disabled /stats and /stats/errors will return empty response. in /preferences, the columns response time and reliability will be empty.
2022-01-05[docs] add documentation for the scripts in searxng_extra/updateMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-01-05[enh] change categories_as_tabs from a list to a dictMartin Fischer
The tab icon names are currently hard coded in the templates. This commit lets us introduce an icon property in the future, e.g: categories_as_tabs: general: icon: search-outline
2022-01-05[mod] move group_engines_in_tab to searx.webutilsMartin Fischer
generated by cgit v1.2.3 (git 2.25.1) at 2026-03-04 03:33:05 +0000