Add tabs to docs (tgcrypto.rst)

This commit is contained in:
Dan 2020-04-01 22:39:39 +02:00
parent 0b93049822
commit 945effc4a9
3 changed files with 20 additions and 11 deletions

View File

@ -1,5 +1,6 @@
sphinx
sphinx_rtd_theme
sphinx_copybutton
sphinx_tabs
pypandoc
requests

View File

@ -35,7 +35,8 @@ extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx.ext.autosummary",
"sphinx_copybutton"
"sphinx_copybutton",
"sphinx_tabs.tabs"
]
master_doc = "index"

View File

@ -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