add sphinx-tabs for better documention shell integration

SwissDataScienceCenter · Dec 14, 2021 · f2644de · f2644de
1 parent b8bdad0
commit f2644de
Show file tree

Hide file tree

Showing 4 changed files with 102 additions and 9 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -47,6 +47,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
     "sphinxcontrib.spelling",
+    "sphinx_tabs.tabs",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/how-to-guides/shell-integration.rst b/docs/how-to-guides/shell-integration.rst
@@ -11,16 +11,30 @@ detailed information about how to setup the tab completion for these shells, ple
 read the `shell completion <https://click.palletsprojects.com/en/8.0.x/shell-completion/>`_
 documentation of click.
 
-For example to activate tab completion for Zsh run the following command after installing
+To activate tab completion for your supported shell run the following command after installing
 Renku CLI:
 
-.. code-block:: console
+.. tabs::
+   .. tab:: bash
+
+        .. code-block:: console
+
+            $ eval "$(_RENKU_COMPLETE=bash_source renku)"
+
+   .. tab:: fish
+
+        .. code-block:: console
+
+            $ eval (env _RENKU_COMPLETE=fish_source renku)
+
+   .. tab:: zsh
 
-   $ eval "$(_RENKU_COMPLETE=zsh_source renku)"
+        .. code-block:: console
 
+            $ eval "$(_RENKU_COMPLETE=zsh_source renku)"
 
-After this not only sub-commands of `renku` will be auto-completed using tab, but for example
-in case of `renku workflow execute` the available ``Plans`` are going to be listed.
+After this not only sub-commands of ``renku`` will be auto-completed using tab, but for example
+in case of ``renku workflow execute`` the available ``Plans`` are going to be listed.
 
 .. code-block:: console