Skip to content

Commit b3b9424

Browse files
Eldinnietsnoam
authored andcommitted
Amazing new documentation.
1 parent 19ce9e4 commit b3b9424

File tree

199 files changed

+4586
-3415
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

199 files changed

+4586
-3415
lines changed

CHANGES.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ Changes
77
- Improved filters for user_id/username/chat.
88
- Internal restructure of files.
99
- Improved unitests.
10-
- Fully support Bot API 3.2.
10+
- Fully support Bot API 3.2
11+
- Modified docstrings
1112
- Remove deprecated ``telegram.Emoji``.
12-
- Remove deprecated ``Botan`` import from ``utils``.
13+
- Remove deprecated ``Botan`` import from ``utils`` (``Botan`` is still available through ``contrib``).
1314
- Remove deprecated ``ReplyKeyboardHide``.
1415
- Remove deprecated ``edit_message`` argument of `bot.set_game_score``.
1516

docs/source/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
Welcome to Python Telegram Bot's documentation!
77
===============================================
88

9+
Below you can find the documentation for the python-telegram-bot library. except for the .ext package most of the
10+
objects in the package reflect the types as defined by the `telegram bot api <https://core.telegram.org/bots/api>`_.
11+
912
.. toctree::
1013
telegram
1114

docs/source/telegram.animation.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
telegram.animation module
2-
=========================
1+
telegram.Animation
2+
==================
33

4-
.. automodule:: telegram.animation
4+
.. autoclass:: telegram.Animation
55
:members:
6-
:undoc-members:
76
:show-inheritance:

docs/source/telegram.audio.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
telegram.audio module
2-
=====================
1+
telegram.Audio
2+
==============
33

4-
.. automodule:: telegram.audio
4+
.. autoclass:: telegram.Audio
55
:members:
6-
:undoc-members:
76
:show-inheritance:

docs/source/telegram.base.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/source/telegram.bot.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
telegram.bot module
2-
===================
1+
telegram.Bot
2+
============
33

4-
.. automodule:: telegram.bot
4+
.. autoclass:: telegram.Bot
55
:members:
6-
:show-inheritance:
6+
:show-inheritance:
Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
telegram.callbackgame module
2-
============================
1+
telegram.Callbackgame
2+
=====================
33

4-
.. automodule:: telegram.callbackgame
4+
.. autoclass:: telegram.CallbackGame
55
:members:
6-
:undoc-members:
76
:show-inheritance:
Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
telegram.callbackquery module
2-
=============================
1+
telegram.CallbackQuery
2+
======================
33

4-
.. automodule:: telegram.callbackquery
4+
.. autoclass:: telegram.CallbackQuery
55
:members:
6-
:undoc-members:
76
:show-inheritance:

docs/source/telegram.chat.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
telegram.chat module
2-
=========================
1+
telegram.Chat
2+
=============
33

4-
.. automodule:: telegram.chat
4+
.. autoclass:: telegram.Chat
55
:members:
6-
:undoc-members:
76
:show-inheritance:
Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
telegram.chataction module
2-
==========================
1+
telegram.ChatAction
2+
===================
33

4-
.. automodule:: telegram.chataction
4+
.. autoclass:: telegram.ChatAction
55
:members:
6-
:undoc-members:
76
:show-inheritance:

0 commit comments

Comments
 (0)