Add tabs to docs (tgcrypto.rst)

delivrance · delivrance · commit 945effc4a9b0 · 2020-04-01T22:39:39.000+02:00
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,6 @@
 sphinx
 sphinx_rtd_theme
 sphinx_copybutton
+sphinx_tabs
 pypandoc
 requests
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -35,7 +35,8 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx.ext.autosummary",
-    "sphinx_copybutton"
+    "sphinx_copybutton",
+    "sphinx_tabs.tabs"
 ]
 
 master_doc = "index"
diff --git a/docs/source/topics/tgcrypto.rst b/docs/source/topics/tgcrypto.rst
@@ -7,12 +7,6 @@ Library specifically written in C for Pyrogram [1]_ as a Python extension.
 TgCrypto is a replacement for the much slower PyAES and implements the crypto algorithms Telegram requires, namely
 **AES-IGE 256 bit** (used in MTProto v2.0) and **AES-CTR 256 bit** (used for CDN encrypted files).
 
-.. contents:: Contents
-    :backlinks: none
-    :local:
-
------
-
 Installation
 ------------
 
@@ -27,10 +21,23 @@ The reason about being an optional package is that TgCrypto requires some extra
 The errors you receive when trying to install TgCrypto are system dependent, but also descriptive enough to understand
 what you should do next:
 
--  **Windows**: Install `Visual C++ 2015 Build Tools <https://www.microsoft.com/en-us/download/details.aspx?id=48159>`_.
--  **macOS**: A pop-up will automatically ask you to install the command line developer tools.
--  **Linux**: Install a proper C compiler (``gcc``, ``clang``) and the Python header files (``python3-dev``).
--  **Termux (Android)**: Install ``clang`` package.
+.. tabs::
+
+    .. tab:: Windows
+
+        Install `Visual C++ 2015 Build Tools <https://www.microsoft.com/en-us/download/details.aspx?id=48159>`_.
+
+    .. tab:: macOS
+
+        A pop-up will automatically ask you to install the command line developer tools.
+
+    .. tab:: Linux
+
+        Install a proper C compiler (``gcc``, ``clang``) and the Python header files (``python3-dev``).
+
+    .. tab:: Termux
+
+        Install ``clang`` package.
 
 .. _TgCrypto: https://github.com/pyrogram/tgcrypto
 

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,8 @@`
`35`	`35`	`"sphinx.ext.autodoc",`
`36`	`36`	`"sphinx.ext.napoleon",`
`37`	`37`	`"sphinx.ext.autosummary",`
`38`		`- "sphinx_copybutton"`
	`38`	`+ "sphinx_copybutton",`
	`39`	`+ "sphinx_tabs.tabs"`
`39`	`40`	`]`
`40`	`41`
`41`	`42`	`master_doc = "index"`