[furo] remove .. contents:: directives

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>
2024-01-01 19:24:07 +01:00 · 2024-04-19 13:24:20 +02:00 · 2024-04-19 13:24:20 +02:00 · 0600cfa34c
commit 0600cfa34c
parent 569da44ddd
65 changed files with 0 additions and 340 deletions
--- 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
 ======================================

--- 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:

--- 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:

--- 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 ..
--- a/docs/dev/engines/enginelib.rst
+++ b/docs/dev/engines/enginelib.rst
@ -4,11 +4,6 @@
 Engine Library
 ==============

-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.enginelib
  :members:

--- 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
--- 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:
--- 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
--- a/docs/dev/engines/offline/nosql-engines.rst
+++ b/docs/dev/engines/offline/nosql-engines.rst
@ -10,11 +10,6 @@ NoSQL databases
   - `redis.io <https://redis.io/>`_
   - `MongoDB <https://www.mongodb.com>`_

-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. sidebar:: info

   Initial sponsored by `Search and Discovery Fund
--- 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
--- 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
--- 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:
--- 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:

--- 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
--- 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:
--- a/docs/dev/engines/online/brave.rst
+++ b/docs/dev/engines/online/brave.rst
@ -4,10 +4,5 @@
 Brave Engines
 =============

-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.brave
  :members:
--- 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:

--- 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:
--- 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:

--- 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
--- 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:
--- 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:
--- 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:
--- 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:
--- 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:
--- a/docs/dev/engines/online/mullvad_leta.rst
+++ b/docs/dev/engines/online/mullvad_leta.rst
@ -4,10 +4,5 @@
 Mullvad-Leta
 ============

-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.mullvad_leta
   :members:
--- 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
--- 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:
--- 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
--- 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:
--- 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:
--- 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:
--- 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:
--- 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:
--- a/docs/dev/engines/online/seekr.rst
+++ b/docs/dev/engines/online/seekr.rst
@ -4,10 +4,5 @@
 Seekr Engines
 =============

-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.seekr
  :members:
--- 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:
--- 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:
--- 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:
--- 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:
--- 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:
--- 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
--- 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:
--- 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:
--- 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:
--- 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:

--- 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:

--- a/docs/dev/lxcdev.rst
+++ b/docs/dev/lxcdev.rst
@ -22,12 +22,6 @@ In this article we will show, how you can make use of Linux Containers (LXC_) in
   section :ref:`internet connectivity docker`.


-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
-
 Motivation
 ==========

--- 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]`_.

--- a/docs/dev/rtm_asdf.rst
+++ b/docs/dev/rtm_asdf.rst
@ -6,12 +6,6 @@ The runtimes are managed with asdf and are activated in this project via the
 `.tool-versions <.tool-versions>`_. If you have not yet installed asdf_, then
 chapter :ref:`introduce asdf` may be of help to you.

-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
-
 Get started
 ===========