From 92afe68d6532c93d455b7eafb827cc18b812a327 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Thu, 26 Dec 2019 10:26:12 +0100
Subject: [PATCH] doc(dev): reST/sphinx add tabbed views extension
 (sphinx_tabs.tabs)

See issue #1785:

  idea: in the doc, provide installation instructions with one tab per
  distrubution

preview (don't bookmark):

  https://return42.github.io/searx/dev/reST.html#tabbed-views

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 docs/conf.py         |  1 +
 docs/dev/reST.rst    | 75 ++++++++++++++++++++++++++++++++++++++++++++
 requirements-dev.txt |  1 +
 3 files changed, 77 insertions(+)

diff --git a/docs/conf.py b/docs/conf.py
index e49562a33..b07e020d1 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -60,6 +60,7 @@ extensions = [
     "sphinxcontrib.jinja",  # https://github.com/tardyp/sphinx-jinja
     'linuxdoc.rstFlatTable',    # Implementation of the 'flat-table' reST-directive.
     'linuxdoc.kfigure',         # Sphinx extension which implements scalable image handling.
+    "sphinx_tabs.tabs", # https://github.com/djungelorm/sphinx-tabs
 ]
 
 intersphinx_mapping = {
diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst
index c6aa990f2..edd7e19b7 100644
--- a/docs/dev/reST.rst
+++ b/docs/dev/reST.rst
@@ -1148,6 +1148,81 @@ points to the name space of the python module: ``webapp``.
    }
 
 
+Tabbed views
+============
+
+.. _sphinx-tabs: https://github.com/djungelorm/sphinx-tabs
+.. _basic-tabs: https://github.com/djungelorm/sphinx-tabs#basic-tabs
+.. _group-tabs: https://github.com/djungelorm/sphinx-tabs#group-tabs
+.. _code-tabs: https://github.com/djungelorm/sphinx-tabs#code-tabs
+
+With `sphinx-tabs`_ extension we have *tabbed views*.  To provide installation
+instructions with one tab per distribution we use the `group-tabs`_ directive,
+others are basic-tabs_ and code-tabs_.
+
+
+.. code:: reST
+
+   .. tabs::
+
+      .. group-tab:: Linux
+
+         Linux Line 1
+
+      .. group-tab:: Mac OSX
+
+         Mac OSX Line 1
+
+      .. group-tab:: Windows
+
+         Windows Line 1
+
+   .. tabs::
+
+      .. group-tab:: Linux
+
+         Linux Line 1
+
+      .. group-tab:: Mac OSX
+
+         Mac OSX Line 1
+
+      .. group-tab:: Windows
+
+         Windows Line 1
+
+
+.. admonition:: Tabbed view (grouped)
+   :class: rst-example
+
+   .. tabs::
+
+      .. group-tab:: Linux
+
+         Linux Line 1
+
+      .. group-tab:: Mac OSX
+
+         Mac OSX Line 1
+
+      .. group-tab:: Windows
+
+         Windows Line 1
+
+   .. tabs::
+
+      .. group-tab:: Linux
+
+         Linux Line 1
+
+      .. group-tab:: Mac OSX
+
+         Mac OSX Line 1
+
+      .. group-tab:: Windows
+
+         Windows Line 1
+
 
 .. _KISS: https://en.wikipedia.org/wiki/KISS_principle
 
diff --git a/requirements-dev.txt b/requirements-dev.txt
index 74754fa8a..3e8f617af 100644
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
@@ -13,3 +13,4 @@ zope.testrunner==4.5.1
 selenium==3.141.0
 linuxdoc @ git+http://github.com/return42/linuxdoc.git
 sphinx-jinja
+sphinx-tabs