mirror of
https://github.com/pyrogram/pyrogram
synced 2025-08-30 22:05:28 +00:00
Docs revamp. Part 2
This commit is contained in:
@@ -13,16 +13,21 @@ Welcome to Pyrogram
|
||||
<b>Telegram MTProto API Framework for Python</b>
|
||||
|
||||
<br>
|
||||
<a href="https://docs.pyrogram.ml">
|
||||
Documentation
|
||||
<a href="https://github.com/pyrogram/pyrogram">
|
||||
GitHub
|
||||
</a>
|
||||
•
|
||||
<a href="https://t.me/PyrogramChat">
|
||||
Community
|
||||
</a>
|
||||
|
||||
•
|
||||
<a href="https://github.com/pyrogram/pyrogram/releases">
|
||||
Changelog
|
||||
</a>
|
||||
•
|
||||
<a href="https://t.me/PyrogramChat">
|
||||
Community
|
||||
<a href="https://pypi.org/project/Pyrogram">
|
||||
PyPI
|
||||
</a>
|
||||
<br>
|
||||
<a href="compiler/api/source/main_api.tl">
|
||||
@@ -49,64 +54,69 @@ Welcome to Pyrogram
|
||||
|
||||
app.run()
|
||||
|
||||
Welcome to Pyrogram's Documentation! Here you can find resources for learning how to use the framework.
|
||||
Contents are organized into self-contained topics and can be accessed from the sidebar, or by following them in order
|
||||
using the Next button at the end of each page. But first, here's a brief overview of what is this all about.
|
||||
|
||||
About
|
||||
-----
|
||||
|
||||
**Pyrogram** is an elegant, easy-to-use Telegram_ client library and framework written from the ground up in Python and C.
|
||||
It enables you to easily create custom apps using both user and bot identities (bot API alternative) via the `MTProto API`_.
|
||||
|
||||
Features
|
||||
--------
|
||||
How the documentation is organized
|
||||
----------------------------------
|
||||
|
||||
- **Easy**: You can install Pyrogram with pip and start building your applications right away.
|
||||
- **Elegant**: Low-level details are abstracted and re-presented in a much nicer and easier way.
|
||||
- **Fast**: Crypto parts are boosted up by TgCrypto_, a high-performance library written in pure C.
|
||||
- **Documented**: Pyrogram API methods, types and public interfaces are well documented.
|
||||
- **Type-hinted**: Exposed Pyrogram types and method parameters are all type-hinted.
|
||||
- **Updated**, to the latest Telegram API version, currently Layer 97 on top of `MTProto 2.0`_.
|
||||
- **Pluggable**: The Smart Plugin system allows to write components with minimal boilerplate code.
|
||||
- **Comprehensive**: Execute any advanced action an official client is able to do, and even more.
|
||||
Contents are organized into self-contained topics and can be accessed from the sidebar, or by following them in order
|
||||
using the Next button at the end of each page.
|
||||
|
||||
To get started, press the Next button.
|
||||
Relevant Pages
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
- `Quick Start`_ - Concise steps to get you started as fast as possible.
|
||||
- `API Usage`_ - Guide on how to use Pyrogram's API.
|
||||
- `Update Handling`_ - Guide on how to handle Telegram updates.
|
||||
- Client_ - Reference details about the Client class.
|
||||
- Types_ - All the available Pyrogram types.
|
||||
- Methods_ - All the available Pyrogram methods.
|
||||
|
||||
**To get started, press the Next button**
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:caption: Quick Start
|
||||
:caption: Introduction
|
||||
|
||||
start/installation
|
||||
start/setup
|
||||
start/usage
|
||||
intro/start
|
||||
intro/install
|
||||
intro/setup
|
||||
intro/auth
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:caption: Resources
|
||||
:caption: Topic Guides
|
||||
|
||||
resources/update-handling
|
||||
resources/using-filters
|
||||
resources/more-on-updates
|
||||
resources/configuration-file
|
||||
resources/smart-plugins
|
||||
resources/auto-authorization
|
||||
resources/customize-sessions
|
||||
resources/tgcrypto
|
||||
resources/text-formatting
|
||||
resources/socks5-proxy
|
||||
resources/bots-interaction
|
||||
resources/error-handling
|
||||
resources/test-servers
|
||||
resources/advanced-usage
|
||||
resources/voice-calls
|
||||
resources/changelog
|
||||
topics/usage
|
||||
topics/update-handling
|
||||
topics/using-filters
|
||||
topics/more-on-updates
|
||||
topics/configuration-file
|
||||
topics/smart-plugins
|
||||
topics/auto-authorization
|
||||
topics/customize-sessions
|
||||
topics/tgcrypto
|
||||
topics/text-formatting
|
||||
topics/socks5-proxy
|
||||
topics/bots-interaction
|
||||
topics/error-handling
|
||||
topics/test-servers
|
||||
topics/advanced-usage
|
||||
topics/voice-calls
|
||||
topics/changelog
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:caption: Main Package
|
||||
:caption: API Reference
|
||||
|
||||
pyrogram/index
|
||||
core/client
|
||||
core/types
|
||||
core/methods
|
||||
core/handlers
|
||||
core/decorators
|
||||
core/filters
|
||||
core/errors
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
@@ -115,7 +125,12 @@ To get started, press the Next button.
|
||||
functions/index
|
||||
types/index
|
||||
|
||||
.. _`Telegram`: https://telegram.org
|
||||
.. _Telegram: https://telegram.org
|
||||
.. _TgCrypto: https://docs.pyrogram.ml/resources/TgCrypto
|
||||
.. _`MTProto API`: https://core.telegram.org/api#telegram-api
|
||||
.. _`MTProto 2.0`: https://core.telegram.org/mtproto
|
||||
.. _MTProto API: https://core.telegram.org/api#telegram-api
|
||||
.. _Quick Start: intro/start.html
|
||||
.. _API Usage: topics/usage.html
|
||||
.. _Update Handling: topics/update-handling.html
|
||||
.. _Client: core/client.html
|
||||
.. _Types: core/types.html
|
||||
.. _Methods: core/methods
|
||||
|
Reference in New Issue
Block a user