diff options
| author | Markus Heiser <markus.heiser@darmarit.de> | 2024-04-19 13:24:20 +0200 |
|---|---|---|
| committer | Markus Heiser <markus.heiser@darmarIT.de> | 2026-05-07 16:19:28 +0200 |
| commit | 50626ef150694555653016b47110dbbd7d2172f9 (patch) | |
| tree | 537c0cda5705f98569557fe868bac80d0660494b /docs/dev | |
| parent | 2f72fc4df2e108c219c1ce91e845e26d102a4f5c (diff) | |
[furo] remove `.. contents::` directives (#3408)
The directive creates a table of contents for the page. However, Furo includes
a table of contents already in the sidebar. It is, thus, recommended to
removing the `.. contents::` directive.
[1] https://github.com/pradyunsg/furo/issues/88#issuecomment-803297274
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev')
51 files changed, 0 insertions, 262 deletions
diff --git a/docs/dev/contribution_guide.rst b/docs/dev/contribution_guide.rst index 026cfbe73..9d6f65d20 100644 --- a/docs/dev/contribution_guide.rst +++ b/docs/dev/contribution_guide.rst @@ -4,11 +4,6 @@ How to contribute ================= -.. contents:: - :depth: 2 - :local: - :backlinks: entry - Prime directives: Privacy, Hackability ====================================== diff --git a/docs/dev/engines/demo/demo_offline.rst b/docs/dev/engines/demo/demo_offline.rst index 1b4cb887f..9424244fd 100644 --- a/docs/dev/engines/demo/demo_offline.rst +++ b/docs/dev/engines/demo/demo_offline.rst @@ -4,11 +4,6 @@ Demo Offline Engine =================== -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.demo_offline :members: diff --git a/docs/dev/engines/demo/demo_online.rst b/docs/dev/engines/demo/demo_online.rst index 9b94207f7..0a8c8e985 100644 --- a/docs/dev/engines/demo/demo_online.rst +++ b/docs/dev/engines/demo/demo_online.rst @@ -4,11 +4,6 @@ Demo Online Engine ================== -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.demo_online :members: diff --git a/docs/dev/engines/engine_overview.rst b/docs/dev/engines/engine_overview.rst index 76741851e..5c2773655 100644 --- a/docs/dev/engines/engine_overview.rst +++ b/docs/dev/engines/engine_overview.rst @@ -4,11 +4,6 @@ Engine Overview =============== -.. contents:: - :depth: 3 - :local: - :backlinks: entry - .. _metasearch-engine: https://en.wikipedia.org/wiki/Metasearch_engine .. sidebar:: Further reading .. diff --git a/docs/dev/engines/index.rst b/docs/dev/engines/index.rst index 8491681cb..c3aecd302 100644 --- a/docs/dev/engines/index.rst +++ b/docs/dev/engines/index.rst @@ -4,12 +4,6 @@ Engine Implementations ====================== -.. contents:: - :depth: 2 - :local: - :backlinks: entry - - .. toctree:: :caption: Framework Components :maxdepth: 2 diff --git a/docs/dev/engines/json_engine.rst b/docs/dev/engines/json_engine.rst index f1a48c6db..587a664a5 100644 --- a/docs/dev/engines/json_engine.rst +++ b/docs/dev/engines/json_engine.rst @@ -4,10 +4,5 @@ JSON Engine ============ -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.json_engine :members: diff --git a/docs/dev/engines/mediawiki.rst b/docs/dev/engines/mediawiki.rst index ce708f95b..b8285661d 100644 --- a/docs/dev/engines/mediawiki.rst +++ b/docs/dev/engines/mediawiki.rst @@ -4,10 +4,5 @@ MediaWiki Engine ================ -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.mediawiki :members: diff --git a/docs/dev/engines/offline/command-line-engines.rst b/docs/dev/engines/offline/command-line-engines.rst index 0a80d698e..71dac68ca 100644 --- a/docs/dev/engines/offline/command-line-engines.rst +++ b/docs/dev/engines/offline/command-line-engines.rst @@ -9,11 +9,6 @@ Command Line Engines - :origin:`command.py <searx/engines/command.py>` - :ref:`offline engines` -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. sidebar:: info Initial sponsored by `Search and Discovery Fund diff --git a/docs/dev/engines/offline/nosql-engines.rst b/docs/dev/engines/offline/nosql-engines.rst index ca18abddf..f43b350de 100644 --- a/docs/dev/engines/offline/nosql-engines.rst +++ b/docs/dev/engines/offline/nosql-engines.rst @@ -10,11 +10,6 @@ NoSQL databases - `valkey.io <https://valkey.io/>`_ - `MongoDB <https://www.mongodb.com>`_ -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. sidebar:: info Initial sponsored by `Search and Discovery Fund diff --git a/docs/dev/engines/offline/search-indexer-engines.rst b/docs/dev/engines/offline/search-indexer-engines.rst index 1751d14b8..98643fb28 100644 --- a/docs/dev/engines/offline/search-indexer-engines.rst +++ b/docs/dev/engines/offline/search-indexer-engines.rst @@ -7,11 +7,6 @@ Local Search APIs - `Comparison to alternatives <https://docs.meilisearch.com/learn/what_is_meilisearch/comparison_to_alternatives.html>`_ -.. contents:: - :depth: 1 - :local: - :backlinks: entry - .. sidebar:: info Initial sponsored by `Search and Discovery Fund diff --git a/docs/dev/engines/offline/sql-engines.rst b/docs/dev/engines/offline/sql-engines.rst index f642f1f29..3fdc7c918 100644 --- a/docs/dev/engines/offline/sql-engines.rst +++ b/docs/dev/engines/offline/sql-engines.rst @@ -10,11 +10,6 @@ SQL Engines - `PostgreSQL <https://www.postgresql.org>`_ - `MySQL <https://www.mysql.com>`_ -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. sidebar:: info Initial sponsored by `Search and Discovery Fund diff --git a/docs/dev/engines/online/adobe_stock.rst b/docs/dev/engines/online/adobe_stock.rst index 48a6511c0..752ce87cb 100644 --- a/docs/dev/engines/online/adobe_stock.rst +++ b/docs/dev/engines/online/adobe_stock.rst @@ -4,10 +4,5 @@ Adobe Stock =========== -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.adobe_stock :members: diff --git a/docs/dev/engines/online/alpinelinux.rst b/docs/dev/engines/online/alpinelinux.rst index 071a1985e..1890dc1c9 100644 --- a/docs/dev/engines/online/alpinelinux.rst +++ b/docs/dev/engines/online/alpinelinux.rst @@ -4,10 +4,5 @@ Alpine Linux Packages ===================== -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.alpinelinux :members: diff --git a/docs/dev/engines/online/annas_archive.rst b/docs/dev/engines/online/annas_archive.rst index db88e5069..22a60d439 100644 --- a/docs/dev/engines/online/annas_archive.rst +++ b/docs/dev/engines/online/annas_archive.rst @@ -4,10 +4,5 @@ Anna's Archive ============== -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.annas_archive :members: diff --git a/docs/dev/engines/online/archlinux.rst b/docs/dev/engines/online/archlinux.rst index 834fffa43..be48b1859 100644 --- a/docs/dev/engines/online/archlinux.rst +++ b/docs/dev/engines/online/archlinux.rst @@ -4,11 +4,6 @@ Arch Linux ========== -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.archlinux :members: diff --git a/docs/dev/engines/online/bing.rst b/docs/dev/engines/online/bing.rst index 19c31aa80..5805ed371 100644 --- a/docs/dev/engines/online/bing.rst +++ b/docs/dev/engines/online/bing.rst @@ -4,12 +4,6 @@ Bing Engines ============ -.. contents:: - :depth: 2 - :local: - :backlinks: entry - - .. _bing web engine: Bing WEB diff --git a/docs/dev/engines/online/bpb.rst b/docs/dev/engines/online/bpb.rst index f545dba48..8f8cf8b48 100644 --- a/docs/dev/engines/online/bpb.rst +++ b/docs/dev/engines/online/bpb.rst @@ -4,10 +4,5 @@ Bpb === -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.bpb :members: diff --git a/docs/dev/engines/online/brave.rst b/docs/dev/engines/online/brave.rst index 96606f3bf..ef83895c1 100644 --- a/docs/dev/engines/online/brave.rst +++ b/docs/dev/engines/online/brave.rst @@ -2,11 +2,6 @@ Brave Engines ============= -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - Brave offers two different engines for SearXNG: 1. The standard engine (``brave``) uses the web interface. diff --git a/docs/dev/engines/online/bt4g.rst b/docs/dev/engines/online/bt4g.rst index 980665204..66bda01b0 100644 --- a/docs/dev/engines/online/bt4g.rst +++ b/docs/dev/engines/online/bt4g.rst @@ -4,11 +4,6 @@ BT4G ==== -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.bt4g :members: diff --git a/docs/dev/engines/online/core.rst b/docs/dev/engines/online/core.rst index 944d97876..b2d0ba935 100644 --- a/docs/dev/engines/online/core.rst +++ b/docs/dev/engines/online/core.rst @@ -4,10 +4,5 @@ CORE ==== -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.core :members: diff --git a/docs/dev/engines/online/dailymotion.rst b/docs/dev/engines/online/dailymotion.rst index c661172e5..84348e2d0 100644 --- a/docs/dev/engines/online/dailymotion.rst +++ b/docs/dev/engines/online/dailymotion.rst @@ -4,10 +4,5 @@ Dailymotion =========== -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.dailymotion :members: diff --git a/docs/dev/engines/online/duckduckgo.rst b/docs/dev/engines/online/duckduckgo.rst index 0f1258ff9..e9753b7dc 100644 --- a/docs/dev/engines/online/duckduckgo.rst +++ b/docs/dev/engines/online/duckduckgo.rst @@ -4,11 +4,6 @@ DuckDuckGo Engines ================== -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.duckduckgo :members: diff --git a/docs/dev/engines/online/google.rst b/docs/dev/engines/online/google.rst index 9085070bd..b232d13c5 100644 --- a/docs/dev/engines/online/google.rst +++ b/docs/dev/engines/online/google.rst @@ -4,12 +4,6 @@ Google Engines ============== -.. contents:: - :depth: 2 - :local: - :backlinks: entry - - .. _google API: Google API diff --git a/docs/dev/engines/online/lemmy.rst b/docs/dev/engines/online/lemmy.rst index 584246fd1..f800d291c 100644 --- a/docs/dev/engines/online/lemmy.rst +++ b/docs/dev/engines/online/lemmy.rst @@ -4,10 +4,5 @@ Lemmy ===== -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.lemmy :members: diff --git a/docs/dev/engines/online/loc.rst b/docs/dev/engines/online/loc.rst index 2ed76cd81..c9311ebc6 100644 --- a/docs/dev/engines/online/loc.rst +++ b/docs/dev/engines/online/loc.rst @@ -4,10 +4,5 @@ Library of Congress =================== -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.loc :members: diff --git a/docs/dev/engines/online/mastodon.rst b/docs/dev/engines/online/mastodon.rst index dc372f121..97eccf33a 100644 --- a/docs/dev/engines/online/mastodon.rst +++ b/docs/dev/engines/online/mastodon.rst @@ -4,10 +4,5 @@ Mastodon ======== -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.mastodon :members: diff --git a/docs/dev/engines/online/moviepilot.rst b/docs/dev/engines/online/moviepilot.rst index ba35574e5..e6ca45d5e 100644 --- a/docs/dev/engines/online/moviepilot.rst +++ b/docs/dev/engines/online/moviepilot.rst @@ -4,10 +4,5 @@ Moviepilot ========== -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.moviepilot :members: diff --git a/docs/dev/engines/online/mrs.rst b/docs/dev/engines/online/mrs.rst index 671f35ea5..8e473a29c 100644 --- a/docs/dev/engines/online/mrs.rst +++ b/docs/dev/engines/online/mrs.rst @@ -4,10 +4,5 @@ Matrix Rooms Search (MRS) ========================= -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.mrs :members: diff --git a/docs/dev/engines/online/mwmbl.rst b/docs/dev/engines/online/mwmbl.rst index 8eac7d7c5..77bda08b2 100644 --- a/docs/dev/engines/online/mwmbl.rst +++ b/docs/dev/engines/online/mwmbl.rst @@ -4,12 +4,6 @@ Mwmbl Engine ============ -.. contents:: - :depth: 2 - :local: - :backlinks: entry - - .. _mwmbl web engine: Mwmbl WEB diff --git a/docs/dev/engines/online/odysee.rst b/docs/dev/engines/online/odysee.rst index 75be1ad11..fea68001e 100644 --- a/docs/dev/engines/online/odysee.rst +++ b/docs/dev/engines/online/odysee.rst @@ -4,10 +4,5 @@ Odysee ====== -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.odysee :members: diff --git a/docs/dev/engines/online/peertube.rst b/docs/dev/engines/online/peertube.rst index bedf055fb..bed0c5e89 100644 --- a/docs/dev/engines/online/peertube.rst +++ b/docs/dev/engines/online/peertube.rst @@ -4,12 +4,6 @@ Peertube Engines ================ -.. contents:: - :depth: 2 - :local: - :backlinks: entry - - .. _peertube video engine: Peertube Video diff --git a/docs/dev/engines/online/piped.rst b/docs/dev/engines/online/piped.rst index 822981056..c9a41a55e 100644 --- a/docs/dev/engines/online/piped.rst +++ b/docs/dev/engines/online/piped.rst @@ -4,10 +4,5 @@ Piped ===== -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.piped :members: diff --git a/docs/dev/engines/online/presearch.rst b/docs/dev/engines/online/presearch.rst index 59332c354..b1d07e009 100644 --- a/docs/dev/engines/online/presearch.rst +++ b/docs/dev/engines/online/presearch.rst @@ -4,10 +4,5 @@ Presearch Engine ================ -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.presearch :members: diff --git a/docs/dev/engines/online/qwant.rst b/docs/dev/engines/online/qwant.rst index 66ad302d1..6ec3b852f 100644 --- a/docs/dev/engines/online/qwant.rst +++ b/docs/dev/engines/online/qwant.rst @@ -4,10 +4,5 @@ Qwant ===== -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.qwant :members: diff --git a/docs/dev/engines/online/radio_browser.rst b/docs/dev/engines/online/radio_browser.rst index a150e59c5..f8665864c 100644 --- a/docs/dev/engines/online/radio_browser.rst +++ b/docs/dev/engines/online/radio_browser.rst @@ -4,10 +4,5 @@ RadioBrowser ============ -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.radio_browser :members: diff --git a/docs/dev/engines/online/recoll.rst b/docs/dev/engines/online/recoll.rst index 2f1a1e4df..c2d1c5743 100644 --- a/docs/dev/engines/online/recoll.rst +++ b/docs/dev/engines/online/recoll.rst @@ -4,10 +4,5 @@ Recoll Engine ============= -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.recoll :members: diff --git a/docs/dev/engines/online/soundcloud.rst b/docs/dev/engines/online/soundcloud.rst index 255bf752c..94b7c3d89 100644 --- a/docs/dev/engines/online/soundcloud.rst +++ b/docs/dev/engines/online/soundcloud.rst @@ -4,10 +4,5 @@ Soundcloud ========== -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.soundcloud :members: diff --git a/docs/dev/engines/online/startpage.rst b/docs/dev/engines/online/startpage.rst index 89e3ad10b..ccac603b8 100644 --- a/docs/dev/engines/online/startpage.rst +++ b/docs/dev/engines/online/startpage.rst @@ -4,10 +4,5 @@ Startpage Engines ================= -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.startpage :members: diff --git a/docs/dev/engines/online/tagesschau.rst b/docs/dev/engines/online/tagesschau.rst index f850bf99b..c4af671cb 100644 --- a/docs/dev/engines/online/tagesschau.rst +++ b/docs/dev/engines/online/tagesschau.rst @@ -4,10 +4,5 @@ Tagesschau API ============== -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.tagesschau :members: diff --git a/docs/dev/engines/online/torznab.rst b/docs/dev/engines/online/torznab.rst index 9056b60d0..0778423a6 100644 --- a/docs/dev/engines/online/torznab.rst +++ b/docs/dev/engines/online/torznab.rst @@ -4,10 +4,5 @@ Torznab WebAPI ============== -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.torznab :members: diff --git a/docs/dev/engines/online/void.rst b/docs/dev/engines/online/void.rst index a1839d4f2..c2b89b6ed 100644 --- a/docs/dev/engines/online/void.rst +++ b/docs/dev/engines/online/void.rst @@ -4,10 +4,5 @@ Void Linux binary packages ========================== -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.voidlinux :members: diff --git a/docs/dev/engines/online/wallhaven.rst b/docs/dev/engines/online/wallhaven.rst index b473293ca..fc1a67403 100644 --- a/docs/dev/engines/online/wallhaven.rst +++ b/docs/dev/engines/online/wallhaven.rst @@ -4,10 +4,5 @@ Wallhaven ========= -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.wallhaven :members: diff --git a/docs/dev/engines/online/wikipedia.rst b/docs/dev/engines/online/wikipedia.rst index d4920f0f6..cd42be826 100644 --- a/docs/dev/engines/online/wikipedia.rst +++ b/docs/dev/engines/online/wikipedia.rst @@ -4,12 +4,6 @@ Wikimedia ========= -.. contents:: - :depth: 2 - :local: - :backlinks: entry - - .. _wikipedia engine: Wikipedia diff --git a/docs/dev/engines/online/yacy.rst b/docs/dev/engines/online/yacy.rst index 9407aca80..dbe99fff8 100644 --- a/docs/dev/engines/online/yacy.rst +++ b/docs/dev/engines/online/yacy.rst @@ -4,10 +4,5 @@ Yacy ==== -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.yacy :members: diff --git a/docs/dev/engines/online/yahoo.rst b/docs/dev/engines/online/yahoo.rst index 96c1e2774..df08550ca 100644 --- a/docs/dev/engines/online/yahoo.rst +++ b/docs/dev/engines/online/yahoo.rst @@ -4,10 +4,5 @@ Yahoo Engine ============ -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.yahoo :members: diff --git a/docs/dev/engines/online/zlibrary.rst b/docs/dev/engines/online/zlibrary.rst index fb197abff..242020ac0 100644 --- a/docs/dev/engines/online/zlibrary.rst +++ b/docs/dev/engines/online/zlibrary.rst @@ -4,10 +4,5 @@ Z-Library ========= -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.zlibrary :members: diff --git a/docs/dev/engines/online_url_search/tineye.rst b/docs/dev/engines/online_url_search/tineye.rst index 3f4db7e0e..79e24cfb8 100644 --- a/docs/dev/engines/online_url_search/tineye.rst +++ b/docs/dev/engines/online_url_search/tineye.rst @@ -4,11 +4,6 @@ Tineye ====== -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.tineye :members: diff --git a/docs/dev/engines/xpath.rst b/docs/dev/engines/xpath.rst index 42c4d47b6..695aa5224 100644 --- a/docs/dev/engines/xpath.rst +++ b/docs/dev/engines/xpath.rst @@ -4,11 +4,6 @@ XPath Engine ============ -.. contents:: - :depth: 2 - :local: - :backlinks: entry - .. automodule:: searx.engines.xpath :members: diff --git a/docs/dev/makefile.rst b/docs/dev/makefile.rst index 7c47fba6b..e354f2d71 100644 --- a/docs/dev/makefile.rst +++ b/docs/dev/makefile.rst @@ -19,11 +19,6 @@ Makefiles, we recommend to read gnu-make_ introduction. To install developer requirements follow :ref:`buildhosts`. -.. contents:: - :depth: 2 - :local: - :backlinks: entry - The usage is simple, just type ``make {target-name}`` to *build* a target. Calling the ``help`` target gives a first overview (``make help``): diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst index e539617b7..d3138a851 100644 --- a/docs/dev/reST.rst +++ b/docs/dev/reST.rst @@ -36,12 +36,6 @@ docs.live <make docs.live>` to build HTML while editing. - SVG_, ImageMagick_ - DOT_, `Graphviz's dot`_, Graphviz_ - -.. contents:: - :depth: 3 - :local: - :backlinks: entry - Sphinx_ and reST_ have their place in the python ecosystem. Over that reST is used in popular projects, e.g the Linux kernel documentation `[kernel doc]`_. diff --git a/docs/dev/templates.rst b/docs/dev/templates.rst index 1995dac48..b43a0ea08 100644 --- a/docs/dev/templates.rst +++ b/docs/dev/templates.rst @@ -14,11 +14,6 @@ type of a result is defined by the :py:obj:`result_type.Result.template`. To set another media-type as :ref:`template default`, the field ``template`` in the result item must be set to the desired type. -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. _result template macros: |
