Skip to content

Commit e94dcd3

Browse files
delivrancedelivrance
committed
Update docs
1 parent 87ad981 commit e94dcd3

28 files changed

+551
-566
lines changed

‎docs/sitemap.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@
2323

2424
dirs = {
2525
".": ("weekly", 1.0),
26-
"intro": ("weekly", 0.8),
27-
"start": ("weekly", 0.8),
28-
"api": ("weekly", 0.6),
29-
"topics": ("weekly", 0.6),
30-
"telegram": ("weekly", 0.4)
26+
"intro": ("weekly", 0.9),
27+
"start": ("weekly", 0.9),
28+
"api": ("weekly", 0.8),
29+
"topics": ("weekly", 0.8),
30+
"telegram": ("weekly", 0.6)
3131
}
3232

3333

‎docs/source/api/bound-methods.rst‎

Lines changed: 58 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -22,43 +22,65 @@ some of the required arguments.
2222
2323
.. currentmodule:: pyrogram
2424

25-
- Message_
26-
- CallbackQuery_
27-
- InlineQuery_
28-
29-
.. _Message:
25+
Index
26+
-----
3027

3128
Message
32-
-------
29+
^^^^^^^
30+
31+
.. hlist::
32+
:columns: 3
33+
34+
- :meth:`~Message.click`
35+
- :meth:`~Message.delete`
36+
- :meth:`~Message.download`
37+
- :meth:`~Message.edit`
38+
- :meth:`~Message.edit_caption`
39+
- :meth:`~Message.edit_media`
40+
- :meth:`~Message.edit_reply_markup`
41+
- :meth:`~Message.forward`
42+
- :meth:`~Message.pin`
43+
- :meth:`~Message.reply`
44+
- :meth:`~Message.reply_animation`
45+
- :meth:`~Message.reply_audio`
46+
- :meth:`~Message.reply_cached_media`
47+
- :meth:`~Message.reply_chat_action`
48+
- :meth:`~Message.reply_contact`
49+
- :meth:`~Message.reply_document`
50+
- :meth:`~Message.reply_game`
51+
- :meth:`~Message.reply_inline_bot_result`
52+
- :meth:`~Message.reply_location`
53+
- :meth:`~Message.reply_media_group`
54+
- :meth:`~Message.reply_photo`
55+
- :meth:`~Message.reply_poll`
56+
- :meth:`~Message.reply_sticker`
57+
- :meth:`~Message.reply_venue`
58+
- :meth:`~Message.reply_video`
59+
- :meth:`~Message.reply_video_note`
60+
- :meth:`~Message.reply_voice`
61+
62+
CallbackQuery
63+
^^^^^^^^^^^^^
64+
65+
.. hlist::
66+
:columns: 2
67+
68+
- :meth:`~CallbackQuery.answer`
69+
70+
InlineQuery
71+
^^^^^^^^^^^
72+
73+
.. hlist::
74+
:columns: 2
3375

34-
- :meth:`Message.click()`
35-
- :meth:`Message.delete()`
36-
- :meth:`Message.download()`
37-
- :meth:`Message.edit()`
38-
- :meth:`Message.edit_caption()`
39-
- :meth:`Message.edit_media()`
40-
- :meth:`Message.edit_reply_markup()`
41-
- :meth:`Message.forward()`
42-
- :meth:`Message.pin()`
43-
- :meth:`Message.reply()`
44-
- :meth:`Message.reply_animation()`
45-
- :meth:`Message.reply_audio()`
46-
- :meth:`Message.reply_cached_media()`
47-
- :meth:`Message.reply_chat_action()`
48-
- :meth:`Message.reply_contact()`
49-
- :meth:`Message.reply_document()`
50-
- :meth:`Message.reply_game()`
51-
- :meth:`Message.reply_inline_bot_result()`
52-
- :meth:`Message.reply_location()`
53-
- :meth:`Message.reply_media_group()`
54-
- :meth:`Message.reply_photo()`
55-
- :meth:`Message.reply_poll()`
56-
- :meth:`Message.reply_sticker()`
57-
- :meth:`Message.reply_venue()`
58-
- :meth:`Message.reply_video()`
59-
- :meth:`Message.reply_video_note()`
60-
- :meth:`Message.reply_voice()`
76+
- :meth:`~InlineQuery.answer`
6177

78+
-----
79+
80+
Details
81+
-------
82+
83+
.. Message
6284
.. automethod:: Message.click()
6385
.. automethod:: Message.delete()
6486
.. automethod:: Message.download()
@@ -87,16 +109,8 @@ Message
87109
.. automethod:: Message.reply_video_note()
88110
.. automethod:: Message.reply_voice()
89111

90-
.. _CallbackQuery:
91-
92-
CallbackQuery
93-
-------------
94-
112+
.. CallbackQuery
95113
.. automethod:: CallbackQuery.answer()
96114

97-
.. _InlineQuery:
98-
99-
InlineQuery
100-
-----------
101-
102-
.. automethod:: InlineQuery.answer()
115+
.. InlineQuery
116+
.. automethod:: InlineQuery.answer()

‎docs/source/api/decorators.rst‎

Lines changed: 36 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Decorators
22
==========
33

4-
While still being methods bound to the :obj:`Client <pyrogram.Client>` class, decorators are of a special kind and thus deserve a
5-
dedicated page.
4+
While still being methods bound to the :class:`~pyrogram.Client` class, decorators are of a special kind and thus
5+
deserve a dedicated page.
66

77
Decorators are able to register callback functions for handling updates in a much easier and cleaner way compared to
8-
`Handlers <Handlers.html>`_; they do so by instantiating the correct handler and calling
9-
:meth:`add_handler() <pyrogram.Client.add_handler>`, automatically. All you need to do is adding the decorators on top
10-
of your functions.
8+
:doc:`Handlers <handlers>`; they do so by instantiating the correct handler and calling
9+
:meth:`~pyrogram.Client.add_handler`, automatically. All you need to do is adding the decorators on top of your
10+
functions.
1111

1212
.. code-block:: python
1313
:emphasize-lines: 6
@@ -24,25 +24,34 @@ of your functions.
2424
2525
app.run()
2626
27-
.. currentmodule:: pyrogram.Client
28-
29-
.. autosummary::
30-
:nosignatures:
31-
32-
on_message
33-
on_callback_query
34-
on_inline_query
35-
on_deleted_messages
36-
on_user_status
37-
on_poll
38-
on_disconnect
39-
on_raw_update
40-
41-
.. automethod:: pyrogram.Client.on_message()
42-
.. automethod:: pyrogram.Client.on_callback_query()
43-
.. automethod:: pyrogram.Client.on_inline_query()
44-
.. automethod:: pyrogram.Client.on_deleted_messages()
45-
.. automethod:: pyrogram.Client.on_user_status()
46-
.. automethod:: pyrogram.Client.on_poll()
47-
.. automethod:: pyrogram.Client.on_disconnect()
48-
.. automethod:: pyrogram.Client.on_raw_update()
27+
.. currentmodule:: pyrogram
28+
29+
Index
30+
-----
31+
32+
.. hlist::
33+
:columns: 3
34+
35+
- :meth:`~Client.on_message`
36+
- :meth:`~Client.on_callback_query`
37+
- :meth:`~Client.on_inline_query`
38+
- :meth:`~Client.on_deleted_messages`
39+
- :meth:`~Client.on_user_status`
40+
- :meth:`~Client.on_poll`
41+
- :meth:`~Client.on_disconnect`
42+
- :meth:`~Client.on_raw_update`
43+
44+
-----
45+
46+
Details
47+
-------
48+
49+
.. Decorators
50+
.. autodecorator:: pyrogram.Client.on_message()
51+
.. autodecorator:: pyrogram.Client.on_callback_query()
52+
.. autodecorator:: pyrogram.Client.on_inline_query()
53+
.. autodecorator:: pyrogram.Client.on_deleted_messages()
54+
.. autodecorator:: pyrogram.Client.on_user_status()
55+
.. autodecorator:: pyrogram.Client.on_poll()
56+
.. autodecorator:: pyrogram.Client.on_disconnect()
57+
.. autodecorator:: pyrogram.Client.on_raw_update()

‎docs/source/api/handlers.rst‎

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ Update Handlers
33

44
Handlers are used to instruct Pyrogram about which kind of updates you'd like to handle with your callback functions.
55

6-
For a much more convenient way of registering callback functions have a look at `Decorators <Decorators.html>`_ instead.
7-
In case you decided to manually create a handler, use :meth:`add_handler() <pyrogram.Client.add_handler>` to register
6+
For a much more convenient way of registering callback functions have a look at :doc:`Decorators <decorators>` instead.
7+
In case you decided to manually create a handler, use :class:`~pyrogram.Client.add_handler` to register
88
it.
99

1010
.. code-block:: python
@@ -25,18 +25,27 @@ it.
2525
2626
.. currentmodule:: pyrogram
2727

28-
.. autosummary::
29-
:nosignatures:
28+
Index
29+
-----
3030

31-
MessageHandler
32-
DeletedMessagesHandler
33-
CallbackQueryHandler
34-
InlineQueryHandler
35-
UserStatusHandler
36-
PollHandler
37-
DisconnectHandler
38-
RawUpdateHandler
31+
.. hlist::
32+
:columns: 3
3933

34+
- :class:`MessageHandler`
35+
- :class:`DeletedMessagesHandler`
36+
- :class:`CallbackQueryHandler`
37+
- :class:`InlineQueryHandler`
38+
- :class:`UserStatusHandler`
39+
- :class:`PollHandler`
40+
- :class:`DisconnectHandler`
41+
- :class:`RawUpdateHandler`
42+
43+
-----
44+
45+
Details
46+
-------
47+
48+
.. Handlers
4049
.. autoclass:: MessageHandler()
4150
.. autoclass:: DeletedMessagesHandler()
4251
.. autoclass:: CallbackQueryHandler()

0 commit comments

Comments
 (0)