[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>
2026-05-07 18:03:51 +02:00 · 2024-04-19 13:24:20 +02:00
parent 2f72fc4df2
commit 50626ef150
68 changed files with 0 additions and 356 deletions
@@ -4,11 +4,6 @@
 Buildhosts
 ==========
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 To get best results from build, it's recommend to install additional packages on
 build hosts (see :ref:`searxng.sh`).
@@ -61,11 +61,6 @@ section might give you some guidance.
   - `Apache Fedora`_
   - `Apache directives`_
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 The Apache HTTP server
 ======================
@@ -41,12 +41,6 @@ section might give you some guidance.
   - `uWSGI support from nginx`_
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 The nginx HTTP server
 =====================
@@ -4,12 +4,6 @@
 Step by step installation
 =========================
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 In this section we show the setup of a SearXNG instance that will be installed
 by the :ref:`installation scripts`.
@@ -9,12 +9,6 @@ uWSGI
   - `systemd.unit`_
   - `uWSGI Emperor`_
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. _systemd.unit: https://www.freedesktop.org/software/systemd/man/systemd.unit.html
 .. _One service per app in systemd:
    https://uwsgi-docs.readthedocs.io/en/latest/Systemd.html#one-service-per-app-in-systemd
@@ -8,11 +8,6 @@ Favicons
   Don't activate the favicons before reading the documentation.
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 Activating the favicons in SearXNG is very easy, but this **generates a
 significantly higher load** in the client/server communication and increases
 resources needed on the server.
@@ -250,4 +245,3 @@ into the *proxy*:
 .. _data URL:
   https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
 .. _FQN: https://en.wikipedia.org/wiki/Fully_qualified_name
@@ -8,10 +8,5 @@ Limiter
   The limiter requires a :ref:`Valkey <settings valkey>` database.
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.limiter
   :members:
@@ -12,11 +12,6 @@ file.
   - :ref:`use_default_settings.yml`
   - :ref:`search API`
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. _settings location:
 settings.yml location
@@ -9,11 +9,6 @@ SearXNG maintenance
   - :ref:`toolboxing`
   - :ref:`uWSGI maintenance`
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. _update searxng:
 How to update
@@ -4,11 +4,6 @@
 How to contribute
 =================
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 Prime directives: Privacy, Hackability
 ======================================
@@ -4,11 +4,6 @@
 Demo Offline Engine
 ===================
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.demo_offline
  :members:
@@ -4,11 +4,6 @@
 Demo Online Engine
 ==================
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.demo_online
  :members:
@@ -4,11 +4,6 @@
 Engine Overview
 ===============
 .. contents::
   :depth: 3
   :local:
   :backlinks: entry
 .. _metasearch-engine: https://en.wikipedia.org/wiki/Metasearch_engine
 .. sidebar:: Further reading ..
@@ -4,12 +4,6 @@
 Engine Implementations
 ======================
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. toctree::
   :caption: Framework Components
   :maxdepth: 2
@@ -4,10 +4,5 @@
 JSON Engine
 ============
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.json_engine
  :members:
@@ -4,10 +4,5 @@
 MediaWiki Engine
 ================
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.mediawiki
  :members:
@@ -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
@@ -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
@@ -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
@@ -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
@@ -4,10 +4,5 @@
 Adobe Stock
 ===========
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.adobe_stock
   :members:
@@ -4,10 +4,5 @@
 Alpine Linux Packages
 =====================
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.alpinelinux
   :members:
@@ -4,10 +4,5 @@
 Anna's Archive
 ==============
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.annas_archive
   :members:
@@ -4,11 +4,6 @@
 Arch Linux
 ==========
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.archlinux
  :members:
@@ -4,12 +4,6 @@
 Bing Engines
 ============
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. _bing web engine:
 Bing WEB
@@ -4,10 +4,5 @@
 Bpb
 ===
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.bpb
  :members:
@@ -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.
@@ -4,11 +4,6 @@
 BT4G
 ====
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.bt4g
  :members:
@@ -4,10 +4,5 @@
 CORE
 ====
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.core
   :members:
@@ -4,10 +4,5 @@
 Dailymotion
 ===========
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.dailymotion
  :members:
@@ -4,11 +4,6 @@
 DuckDuckGo Engines
 ==================
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.duckduckgo
   :members:
@@ -4,12 +4,6 @@
 Google Engines
 ==============
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. _google API:
 Google API
@@ -4,10 +4,5 @@
 Lemmy
 =====
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.lemmy
   :members:
@@ -4,10 +4,5 @@
 Library of Congress
 ===================
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.loc
  :members:
@@ -4,10 +4,5 @@
 Mastodon
 ========
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.mastodon
  :members:
@@ -4,10 +4,5 @@
 Moviepilot
 ==========
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.moviepilot
   :members:
@@ -4,10 +4,5 @@
 Matrix Rooms Search (MRS)
 =========================
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.mrs
   :members:
@@ -4,12 +4,6 @@
 Mwmbl Engine
 ============
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. _mwmbl web engine:
 Mwmbl WEB
@@ -4,10 +4,5 @@
 Odysee
 ======
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.odysee
  :members:
@@ -4,12 +4,6 @@
 Peertube Engines
 ================
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. _peertube video engine:
 Peertube Video
@@ -4,10 +4,5 @@
 Piped
 =====
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.piped
  :members:
@@ -4,10 +4,5 @@
 Presearch Engine
 ================
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.presearch
   :members:
@@ -4,10 +4,5 @@
 Qwant
 =====
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.qwant
   :members:
@@ -4,10 +4,5 @@
 RadioBrowser
 ============
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.radio_browser
   :members:
@@ -4,10 +4,5 @@
 Recoll Engine
 =============
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.recoll
   :members:
@@ -4,10 +4,5 @@
 Soundcloud
 ==========
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.soundcloud
   :members:
@@ -4,10 +4,5 @@
 Startpage Engines
 =================
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.startpage
   :members:
@@ -4,10 +4,5 @@
 Tagesschau API
 ==============
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.tagesschau
  :members:
@@ -4,10 +4,5 @@
 Torznab WebAPI
 ==============
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.torznab
   :members:
@@ -4,10 +4,5 @@
 Void Linux binary packages
 ==========================
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.voidlinux
  :members:
@@ -4,10 +4,5 @@
 Wallhaven
 =========
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.wallhaven
  :members:
@@ -4,12 +4,6 @@
 Wikimedia
 =========
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. _wikipedia engine:
 Wikipedia
@@ -4,10 +4,5 @@
 Yacy
 ====
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.yacy
  :members:
@@ -4,10 +4,5 @@
 Yahoo Engine
 ============
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.yahoo
  :members:
@@ -4,10 +4,5 @@
 Z-Library
 =========
 .. contents:: Contents
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.zlibrary
  :members:
@@ -4,11 +4,6 @@
 Tineye
 ======
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.tineye
  :members:
@@ -4,11 +4,6 @@
 XPath Engine
 ============
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.engines.xpath
  :members:
@@ -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``):
@@ -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]`_.
@@ -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:
@@ -7,11 +7,6 @@ Why use a private instance?
  \.\.\.is a common question among SearXNG users.  Before answering this
  question, see what options a SearXNG user has.
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 Public instances are open to everyone who has access to their URL.  Usually, they
 are operated by unknown parties (from the users' point of view).  Private
 instances can be used by a select group of people, such as a SearXNG instance for a
@@ -4,11 +4,6 @@
 Bot Detection
 =============
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.botdetection
  :members:
@@ -4,11 +4,6 @@
 Favicons (source)
 =================
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.favicons
   :members:
@@ -43,6 +38,3 @@ Favicons Cache
 .. automodule:: searx.favicons.cache
   :members:
@@ -4,11 +4,6 @@
 Locales
 =======
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. automodule:: searx.locales
   :members:
@@ -4,12 +4,6 @@
 Search processors
 =================
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 Abstract processor class
 ========================
@@ -22,11 +22,6 @@ Configured Engines
   called *tabs*), engines can be queried by their name or the categories they
   belong to, by using a :ref:`\!bing syntax <search-syntax>`.
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 .. jinja:: searx
   {% for category, engines in categories_as_tabs.items() %}
@@ -2,11 +2,6 @@
 User information
 ================
 .. contents::
   :depth: 3
   :local:
   :backlinks: entry
 .. toctree::
   :maxdepth: 2
@@ -15,12 +15,6 @@ script :origin:`utils/searxng.sh`.
   - :ref:`installation nginx`
   - :ref:`installation apache`
 .. contents::
   :depth: 2
   :local:
   :backlinks: entry
 Install
 =======