[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>
This commit is contained in:
Markus Heiser 2024-04-19 13:24:20 +02:00
parent 569da44ddd
commit 0600cfa34c
65 changed files with 0 additions and 340 deletions

View file

@ -4,11 +4,6 @@
Buildhosts Buildhosts
========== ==========
.. contents::
:depth: 2
:local:
:backlinks: entry
To get best results from build, it's recommend to install additional packages on To get best results from build, it's recommend to install additional packages on
build hosts (see :ref:`searxng.sh`). build hosts (see :ref:`searxng.sh`).

View file

@ -61,11 +61,6 @@ section might give you some guidance.
- `Apache Fedora`_ - `Apache Fedora`_
- `Apache directives`_ - `Apache directives`_
.. contents::
:depth: 2
:local:
:backlinks: entry
The Apache HTTP server The Apache HTTP server
====================== ======================

View file

@ -41,12 +41,6 @@ section might give you some guidance.
- `uWSGI support from nginx`_ - `uWSGI support from nginx`_
.. contents::
:depth: 2
:local:
:backlinks: entry
The nginx HTTP server The nginx HTTP server
===================== =====================

View file

@ -4,12 +4,6 @@
Step by step installation 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 In this section we show the setup of a SearXNG instance that will be installed
by the :ref:`installation scripts`. by the :ref:`installation scripts`.

View file

@ -9,12 +9,6 @@ uWSGI
- `systemd.unit`_ - `systemd.unit`_
- `uWSGI Emperor`_ - `uWSGI Emperor`_
.. contents::
:depth: 2
:local:
:backlinks: entry
.. _systemd.unit: https://www.freedesktop.org/software/systemd/man/systemd.unit.html .. _systemd.unit: https://www.freedesktop.org/software/systemd/man/systemd.unit.html
.. _One service per app in systemd: .. _One service per app in systemd:
https://uwsgi-docs.readthedocs.io/en/latest/Systemd.html#one-service-per-app-in-systemd https://uwsgi-docs.readthedocs.io/en/latest/Systemd.html#one-service-per-app-in-systemd

View file

@ -8,10 +8,5 @@ Limiter
The limiter requires a :ref:`Redis <settings redis>` database. The limiter requires a :ref:`Redis <settings redis>` database.
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.limiter .. automodule:: searx.limiter
:members: :members:

View file

@ -12,11 +12,6 @@ file.
- :ref:`use_default_settings.yml` - :ref:`use_default_settings.yml`
- :ref:`search API` - :ref:`search API`
.. contents::
:depth: 2
:local:
:backlinks: entry
.. _settings location: .. _settings location:
settings.yml location settings.yml location

View file

@ -9,11 +9,6 @@ SearXNG maintenance
- :ref:`toolboxing` - :ref:`toolboxing`
- :ref:`uWSGI maintenance` - :ref:`uWSGI maintenance`
.. contents::
:depth: 2
:local:
:backlinks: entry
.. _update searxng: .. _update searxng:
How to update How to update

View file

@ -4,11 +4,6 @@
How to contribute How to contribute
================= =================
.. contents::
:depth: 2
:local:
:backlinks: entry
Prime directives: Privacy, Hackability Prime directives: Privacy, Hackability
====================================== ======================================

View file

@ -4,11 +4,6 @@
Demo Offline Engine Demo Offline Engine
=================== ===================
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.demo_offline .. automodule:: searx.engines.demo_offline
:members: :members:

View file

@ -4,11 +4,6 @@
Demo Online Engine Demo Online Engine
================== ==================
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.demo_online .. automodule:: searx.engines.demo_online
:members: :members:

View file

@ -4,11 +4,6 @@
Engine Overview Engine Overview
=============== ===============
.. contents::
:depth: 3
:local:
:backlinks: entry
.. _metasearch-engine: https://en.wikipedia.org/wiki/Metasearch_engine .. _metasearch-engine: https://en.wikipedia.org/wiki/Metasearch_engine
.. sidebar:: Further reading .. .. sidebar:: Further reading ..

View file

@ -4,11 +4,6 @@
Engine Library Engine Library
============== ==============
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.enginelib .. automodule:: searx.enginelib
:members: :members:

View file

@ -4,12 +4,6 @@
Engine Implementations Engine Implementations
====================== ======================
.. contents::
:depth: 2
:local:
:backlinks: entry
.. toctree:: .. toctree::
:caption: Framework Components :caption: Framework Components
:maxdepth: 2 :maxdepth: 2

View file

@ -4,10 +4,5 @@
MediaWiki Engine MediaWiki Engine
================ ================
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.mediawiki .. automodule:: searx.engines.mediawiki
:members: :members:

View file

@ -9,11 +9,6 @@ Command Line Engines
- :origin:`command.py <searx/engines/command.py>` - :origin:`command.py <searx/engines/command.py>`
- :ref:`offline engines` - :ref:`offline engines`
.. contents::
:depth: 2
:local:
:backlinks: entry
.. sidebar:: info .. sidebar:: info
Initial sponsored by `Search and Discovery Fund Initial sponsored by `Search and Discovery Fund

View file

@ -10,11 +10,6 @@ NoSQL databases
- `redis.io <https://redis.io/>`_ - `redis.io <https://redis.io/>`_
- `MongoDB <https://www.mongodb.com>`_ - `MongoDB <https://www.mongodb.com>`_
.. contents::
:depth: 2
:local:
:backlinks: entry
.. sidebar:: info .. sidebar:: info
Initial sponsored by `Search and Discovery Fund Initial sponsored by `Search and Discovery Fund

View file

@ -7,11 +7,6 @@ Local Search APIs
- `Comparison to alternatives - `Comparison to alternatives
<https://docs.meilisearch.com/learn/what_is_meilisearch/comparison_to_alternatives.html>`_ <https://docs.meilisearch.com/learn/what_is_meilisearch/comparison_to_alternatives.html>`_
.. contents::
:depth: 1
:local:
:backlinks: entry
.. sidebar:: info .. sidebar:: info
Initial sponsored by `Search and Discovery Fund Initial sponsored by `Search and Discovery Fund

View file

@ -10,11 +10,6 @@ SQL Engines
- `PostgreSQL <https://www.postgresql.org>`_ - `PostgreSQL <https://www.postgresql.org>`_
- `MySQL <https://www.mysql.com>`_ - `MySQL <https://www.mysql.com>`_
.. contents::
:depth: 2
:local:
:backlinks: entry
.. sidebar:: info .. sidebar:: info
Initial sponsored by `Search and Discovery Fund Initial sponsored by `Search and Discovery Fund

View file

@ -4,10 +4,5 @@
Anna's Archive Anna's Archive
============== ==============
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.annas_archive .. automodule:: searx.engines.annas_archive
:members: :members:

View file

@ -4,11 +4,6 @@
Arch Linux Arch Linux
========== ==========
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.archlinux .. automodule:: searx.engines.archlinux
:members: :members:

View file

@ -4,12 +4,6 @@
Bing Engines Bing Engines
============ ============
.. contents::
:depth: 2
:local:
:backlinks: entry
.. _bing web engine: .. _bing web engine:
Bing WEB Bing WEB

View file

@ -4,10 +4,5 @@
Bpb Bpb
=== ===
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.bpb .. automodule:: searx.engines.bpb
:members: :members:

View file

@ -4,10 +4,5 @@
Brave Engines Brave Engines
============= =============
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.brave .. automodule:: searx.engines.brave
:members: :members:

View file

@ -4,11 +4,6 @@
BT4G BT4G
==== ====
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.bt4g .. automodule:: searx.engines.bt4g
:members: :members:

View file

@ -4,10 +4,5 @@
Dailymotion Dailymotion
=========== ===========
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.dailymotion .. automodule:: searx.engines.dailymotion
:members: :members:

View file

@ -4,11 +4,6 @@
DuckDuckGo Engines DuckDuckGo Engines
================== ==================
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.duckduckgo .. automodule:: searx.engines.duckduckgo
:members: :members:

View file

@ -4,12 +4,6 @@
Google Engines Google Engines
============== ==============
.. contents::
:depth: 2
:local:
:backlinks: entry
.. _google API: .. _google API:
Google API Google API

View file

@ -4,10 +4,5 @@
Lemmy Lemmy
===== =====
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.lemmy .. automodule:: searx.engines.lemmy
:members: :members:

View file

@ -4,10 +4,5 @@
Library of Congress Library of Congress
=================== ===================
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.loc .. automodule:: searx.engines.loc
:members: :members:

View file

@ -4,10 +4,5 @@
Mastodon Mastodon
======== ========
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.mastodon .. automodule:: searx.engines.mastodon
:members: :members:

View file

@ -4,10 +4,5 @@
Moviepilot Moviepilot
========== ==========
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.moviepilot .. automodule:: searx.engines.moviepilot
:members: :members:

View file

@ -4,10 +4,5 @@
Matrix Rooms Search (MRS) Matrix Rooms Search (MRS)
========================= =========================
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.mrs .. automodule:: searx.engines.mrs
:members: :members:

View file

@ -4,10 +4,5 @@
Mullvad-Leta Mullvad-Leta
============ ============
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.mullvad_leta .. automodule:: searx.engines.mullvad_leta
:members: :members:

View file

@ -4,12 +4,6 @@
Mwmbl Engine Mwmbl Engine
============ ============
.. contents::
:depth: 2
:local:
:backlinks: entry
.. _mwmbl web engine: .. _mwmbl web engine:
Mwmbl WEB Mwmbl WEB

View file

@ -4,10 +4,5 @@
Odysee Odysee
====== ======
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.odysee .. automodule:: searx.engines.odysee
:members: :members:

View file

@ -4,12 +4,6 @@
Peertube Engines Peertube Engines
================ ================
.. contents::
:depth: 2
:local:
:backlinks: entry
.. _peertube video engine: .. _peertube video engine:
Peertube Video Peertube Video

View file

@ -4,10 +4,5 @@
Piped Piped
===== =====
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.piped .. automodule:: searx.engines.piped
:members: :members:

View file

@ -4,10 +4,5 @@
Presearch Engine Presearch Engine
================ ================
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.presearch .. automodule:: searx.engines.presearch
:members: :members:

View file

@ -4,10 +4,5 @@
Qwant Qwant
===== =====
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.qwant .. automodule:: searx.engines.qwant
:members: :members:

View file

@ -4,10 +4,5 @@
RadioBrowser RadioBrowser
============ ============
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.radio_browser .. automodule:: searx.engines.radio_browser
:members: :members:

View file

@ -4,10 +4,5 @@
Recoll Engine Recoll Engine
============= =============
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.recoll .. automodule:: searx.engines.recoll
:members: :members:

View file

@ -4,10 +4,5 @@
Seekr Engines Seekr Engines
============= =============
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.seekr .. automodule:: searx.engines.seekr
:members: :members:

View file

@ -4,10 +4,5 @@
Startpage Engines Startpage Engines
================= =================
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.startpage .. automodule:: searx.engines.startpage
:members: :members:

View file

@ -4,10 +4,5 @@
Tagesschau API Tagesschau API
============== ==============
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.tagesschau .. automodule:: searx.engines.tagesschau
:members: :members:

View file

@ -4,10 +4,5 @@
Torznab WebAPI Torznab WebAPI
============== ==============
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.torznab .. automodule:: searx.engines.torznab
:members: :members:

View file

@ -4,10 +4,5 @@
Void Linux binary packages Void Linux binary packages
========================== ==========================
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.voidlinux .. automodule:: searx.engines.voidlinux
:members: :members:

View file

@ -4,10 +4,5 @@
Wallhaven Wallhaven
========= =========
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.wallhaven .. automodule:: searx.engines.wallhaven
:members: :members:

View file

@ -4,12 +4,6 @@
Wikimedia Wikimedia
========= =========
.. contents::
:depth: 2
:local:
:backlinks: entry
.. _wikipedia engine: .. _wikipedia engine:
Wikipedia Wikipedia

View file

@ -4,10 +4,5 @@
Yacy Yacy
==== ====
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.yacy .. automodule:: searx.engines.yacy
:members: :members:

View file

@ -4,10 +4,5 @@
Yahoo Engine Yahoo Engine
============ ============
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.yahoo .. automodule:: searx.engines.yahoo
:members: :members:

View file

@ -4,10 +4,5 @@
Z-Library Z-Library
========= =========
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.zlibrary .. automodule:: searx.engines.zlibrary
:members: :members:

View file

@ -4,11 +4,6 @@
Tineye Tineye
====== ======
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.tineye .. automodule:: searx.engines.tineye
:members: :members:

View file

@ -4,11 +4,6 @@
XPath Engine XPath Engine
============ ============
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.xpath .. automodule:: searx.engines.xpath
:members: :members:

View file

@ -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`. section :ref:`internet connectivity docker`.
.. contents::
:depth: 2
:local:
:backlinks: entry
Motivation Motivation
========== ==========

View file

@ -36,12 +36,6 @@ docs.live <make docs.live>` to build HTML while editing.
- SVG_, ImageMagick_ - SVG_, ImageMagick_
- DOT_, `Graphviz's dot`_, Graphviz_ - 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 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]`_. used in popular projects, e.g the Linux kernel documentation `[kernel doc]`_.

View file

@ -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 `.tool-versions <.tool-versions>`_. If you have not yet installed asdf_, then
chapter :ref:`introduce asdf` may be of help to you. chapter :ref:`introduce asdf` may be of help to you.
.. contents::
:depth: 2
:local:
:backlinks: entry
Get started Get started
=========== ===========

View file

@ -7,11 +7,6 @@ Why use a private instance?
\.\. is a common question among SearXNG users. Before answering this \.\. is a common question among SearXNG users. Before answering this
question, see what options a SearXNG user has. question, see what options a SearXNG user has.
.. contents::
:depth: 2
:local:
:backlinks: entry
Public instances are open to everyone who has access to its URL. Usually, these Public instances are open to everyone who has access to its URL. Usually, these
are operated by unknown parties (from the users' point of view). Private are operated by unknown parties (from the users' point of view). Private
instances can be used by a select group of people. It is for example a SearXNG of instances can be used by a select group of people. It is for example a SearXNG of

View file

@ -4,11 +4,6 @@
Bot Detection Bot Detection
============= =============
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.botdetection .. automodule:: searx.botdetection
:members: :members:

View file

@ -4,11 +4,6 @@
Locales Locales
======= =======
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.locales .. automodule:: searx.locales
:members: :members:

View file

@ -4,12 +4,6 @@
Search processors Search processors
================= =================
.. contents::
:depth: 2
:local:
:backlinks: entry
Abstract processor class Abstract processor class
======================== ========================

View file

@ -22,11 +22,6 @@ Configured Engines
called *tabs*), engines can be queried by their name or the categories they called *tabs*), engines can be queried by their name or the categories they
belong to, by using a :ref:`\!bing syntax <search-syntax>`. belong to, by using a :ref:`\!bing syntax <search-syntax>`.
.. contents::
:depth: 2
:local:
:backlinks: entry
.. jinja:: searx .. jinja:: searx
{% for category, engines in categories_as_tabs.items() %} {% for category, engines in categories_as_tabs.items() %}

View file

@ -2,11 +2,6 @@
User information User information
================ ================
.. contents::
:depth: 3
:local:
:backlinks: entry
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

View file

@ -26,12 +26,6 @@ to care about*).
- `LXC/LXD Image Server`_ - `LXC/LXD Image Server`_
- `LXD@github`_ - `LXD@github`_
.. contents::
:depth: 2
:local:
:backlinks: entry
.. _lxd install: .. _lxd install:
Install LXD Install LXD

View file

@ -15,12 +15,6 @@ script :origin:`utils/searxng.sh`.
- :ref:`installation nginx` - :ref:`installation nginx`
- :ref:`installation apache` - :ref:`installation apache`
.. contents::
:depth: 2
:local:
:backlinks: entry
Install Install
======= =======