pyrogram/docs/source/index.rst
2018-01-03 18:26:05 +01:00

41 lines
1.0 KiB
ReStructuredText

Welcome to Pyrogram
===================
.. raw:: html
<div align="center">
<a href="https://pyrogram.ml">
<img src="https://pyrogram.ml/images/logo2.png" alt="Logo">
</a>
</div>
<p align="center">
<b>Telegram MTProto API Client Library for Python</b>
</p>
Welcome to Pyrogram's documentation. Here you can find a detailed description of the Pyrogram API.
You will notice that methods are named after the well established `Telegram Bot API`_ and that most of them
accept the same parameters as well.
.. note::
This document is intended to be used as an API reference documentation.
For more information on how to install and setup the library, please refer to the Wiki_.
.. toctree::
:caption: Pyrogram Package
pyrogram/Client
pyrogram/ChatAction
pyrogram/Error
.. toctree::
:caption: Telegram API
methods/index
types/index
.. _Wiki: https://github.com/pyrogram/pyrogram/wiki
.. _`Telegram Bot API`: https://core.telegram.org/bots/api#available-methods