git.iko.soy/searx
on master help sign in
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>

commit92afe68d6532c93d455b7eafb827cc18b812a327 authorMarkus Heiser <markus.heiser@darmarit.de> dateThu 26 Dec 2019, 10:26 (7 years ago) parent62505f8
3 files changed+77
compare with master
unifiedsplit
docs/conf.py+1 docs/dev/reST.rst+75 requirements-dev.txt+1
docs/conf.py+1
@@ -60,6 +60,7 @@ extensions = [
6060 "sphinxcontrib.jinja", # https://github.com/tardyp/sphinx-jinja
6161 'linuxdoc.rstFlatTable', # Implementation of the 'flat-table' reST-directive.
6262 'linuxdoc.kfigure', # Sphinx extension which implements scalable image handling.
63+ "sphinx_tabs.tabs", # https://github.com/djungelorm/sphinx-tabs
6364]
6465
6566intersphinx_mapping = {
docs/dev/reST.rst+75
@@ -1148,6 +1148,81 @@ points to the name space of the python module: ``webapp``.
11481148 }
11491149
11501150
1151+Tabbed views
1152+============
1153+
1154+.. _sphinx-tabs: https://github.com/djungelorm/sphinx-tabs
1155+.. _basic-tabs: https://github.com/djungelorm/sphinx-tabs#basic-tabs
1156+.. _group-tabs: https://github.com/djungelorm/sphinx-tabs#group-tabs
1157+.. _code-tabs: https://github.com/djungelorm/sphinx-tabs#code-tabs
1158+
1159+With `sphinx-tabs`_ extension we have *tabbed views*. To provide installation
1160+instructions with one tab per distribution we use the `group-tabs`_ directive,
1161+others are basic-tabs_ and code-tabs_.
1162+
1163+
1164+.. code:: reST
1165+
1166+ .. tabs::
1167+
1168+ .. group-tab:: Linux
1169+
1170+ Linux Line 1
1171+
1172+ .. group-tab:: Mac OSX
1173+
1174+ Mac OSX Line 1
1175+
1176+ .. group-tab:: Windows
1177+
1178+ Windows Line 1
1179+
1180+ .. tabs::
1181+
1182+ .. group-tab:: Linux
1183+
1184+ Linux Line 1
1185+
1186+ .. group-tab:: Mac OSX
1187+
1188+ Mac OSX Line 1
1189+
1190+ .. group-tab:: Windows
1191+
1192+ Windows Line 1
1193+
1194+
1195+.. admonition:: Tabbed view (grouped)
1196+ :class: rst-example
1197+
1198+ .. tabs::
1199+
1200+ .. group-tab:: Linux
1201+
1202+ Linux Line 1
1203+
1204+ .. group-tab:: Mac OSX
1205+
1206+ Mac OSX Line 1
1207+
1208+ .. group-tab:: Windows
1209+
1210+ Windows Line 1
1211+
1212+ .. tabs::
1213+
1214+ .. group-tab:: Linux
1215+
1216+ Linux Line 1
1217+
1218+ .. group-tab:: Mac OSX
1219+
1220+ Mac OSX Line 1
1221+
1222+ .. group-tab:: Windows
1223+
1224+ Windows Line 1
1225+
11511226
11521227.. _KISS: https://en.wikipedia.org/wiki/KISS_principle
11531228
requirements-dev.txt+1
@@ -13,3 +13,4 @@ zope.testrunner==4.5.1
1313selenium==3.141.0
1414linuxdoc @ git+http://github.com/return42/linuxdoc.git
1515sphinx-jinja
16+sphinx-tabs