mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-12-31 16:40:53 +01:00
[ci skip] docs: add all missing classes
This commit is contained in:
parent
dabbbcafcb
commit
65061f8a99
13 changed files with 97 additions and 17 deletions
7
docs/source/telegram.animation.rst
Normal file
7
docs/source/telegram.animation.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
telegram.animation module
|
||||||
|
=========================
|
||||||
|
|
||||||
|
.. automodule:: telegram.animation
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
7
docs/source/telegram.callbackgame.rst
Normal file
7
docs/source/telegram.callbackgame.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
telegram.callbackgame module
|
||||||
|
============================
|
||||||
|
|
||||||
|
.. automodule:: telegram.callbackgame
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
7
docs/source/telegram.chatmember.rst
Normal file
7
docs/source/telegram.chatmember.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
telegram.chatmember module
|
||||||
|
==========================
|
||||||
|
|
||||||
|
.. automodule:: telegram.chatmember
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
7
docs/source/telegram.game.rst
Normal file
7
docs/source/telegram.game.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
telegram.game module
|
||||||
|
====================
|
||||||
|
|
||||||
|
.. automodule:: telegram.game
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
7
docs/source/telegram.gamehighscore.rst
Normal file
7
docs/source/telegram.gamehighscore.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
telegram.gamehighscore module
|
||||||
|
=============================
|
||||||
|
|
||||||
|
.. automodule:: telegram.gamehighscore
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
7
docs/source/telegram.keyboardbutton.rst
Normal file
7
docs/source/telegram.keyboardbutton.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
telegram.keyboardbutton module
|
||||||
|
==============================
|
||||||
|
|
||||||
|
.. automodule:: telegram.keyboardbutton
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
7
docs/source/telegram.messageentity.rst
Normal file
7
docs/source/telegram.messageentity.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
telegram.messageentity module
|
||||||
|
=============================
|
||||||
|
|
||||||
|
.. automodule:: telegram.messageentity
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
7
docs/source/telegram.parsemode.rst
Normal file
7
docs/source/telegram.parsemode.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
telegram.parsemode module
|
||||||
|
=========================
|
||||||
|
|
||||||
|
.. automodule:: telegram.parsemode
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
|
@ -6,16 +6,28 @@ Submodules
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
|
||||||
|
telegram.contrib
|
||||||
|
telegram.ext
|
||||||
|
telegram.animation
|
||||||
telegram.audio
|
telegram.audio
|
||||||
telegram.base
|
telegram.base
|
||||||
telegram.bot
|
telegram.bot
|
||||||
|
telegram.callbackgame
|
||||||
|
telegram.chat
|
||||||
|
telegram.chataction
|
||||||
|
telegram.chatmember
|
||||||
|
telegram.choseninlineresult
|
||||||
telegram.constants
|
telegram.constants
|
||||||
telegram.contrib
|
telegram.contact
|
||||||
telegram.ext
|
telegram.document
|
||||||
telegram.inlinequery
|
telegram.error
|
||||||
telegram.inlinequeryresult
|
telegram.forcereply
|
||||||
|
telegram.game
|
||||||
|
telegram.gamehighscore
|
||||||
telegram.inlinekeyboardbutton
|
telegram.inlinekeyboardbutton
|
||||||
telegram.inlinekeyboardmarkup
|
telegram.inlinekeyboardmarkup
|
||||||
|
telegram.inlinequery
|
||||||
|
telegram.inlinequeryresult
|
||||||
telegram.inlinequeryresultarticle
|
telegram.inlinequeryresultarticle
|
||||||
telegram.inlinequeryresultaudio
|
telegram.inlinequeryresultaudio
|
||||||
telegram.inlinequeryresultcachedaudio
|
telegram.inlinequeryresultcachedaudio
|
||||||
|
@ -35,16 +47,12 @@ Submodules
|
||||||
telegram.inlinequeryresultvenue
|
telegram.inlinequeryresultvenue
|
||||||
telegram.inlinequeryresultvideo
|
telegram.inlinequeryresultvideo
|
||||||
telegram.inlinequeryresultvoice
|
telegram.inlinequeryresultvoice
|
||||||
telegram.choseninlineresult
|
|
||||||
telegram.chataction
|
|
||||||
telegram.contact
|
|
||||||
telegram.document
|
|
||||||
telegram.error
|
|
||||||
telegram.forcereply
|
|
||||||
telegram.chat
|
|
||||||
telegram.inputfile
|
telegram.inputfile
|
||||||
|
telegram.keyboardbutton
|
||||||
telegram.location
|
telegram.location
|
||||||
telegram.message
|
telegram.message
|
||||||
|
telegram.messageentity
|
||||||
|
telegram.parsemode
|
||||||
telegram.photosize
|
telegram.photosize
|
||||||
telegram.replykeyboardhide
|
telegram.replykeyboardhide
|
||||||
telegram.replykeyboardmarkup
|
telegram.replykeyboardmarkup
|
||||||
|
@ -53,8 +61,10 @@ Submodules
|
||||||
telegram.update
|
telegram.update
|
||||||
telegram.user
|
telegram.user
|
||||||
telegram.userprofilephotos
|
telegram.userprofilephotos
|
||||||
|
telegram.venue
|
||||||
telegram.video
|
telegram.video
|
||||||
telegram.voice
|
telegram.voice
|
||||||
|
telegram.webhookinfo
|
||||||
|
|
||||||
Module contents
|
Module contents
|
||||||
---------------
|
---------------
|
||||||
|
|
7
docs/source/telegram.venue.rst
Normal file
7
docs/source/telegram.venue.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
telegram.venue module
|
||||||
|
=====================
|
||||||
|
|
||||||
|
.. automodule:: telegram.venue
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
7
docs/source/telegram.webhookinfo.rst
Normal file
7
docs/source/telegram.webhookinfo.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
telegram.webhookinfo module
|
||||||
|
===========================
|
||||||
|
|
||||||
|
.. automodule:: telegram.webhookinfo
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
|
@ -101,8 +101,8 @@ class Game(TelegramObject):
|
||||||
(That is, you can't just slice ``Message.text`` with the offset and length.)
|
(That is, you can't just slice ``Message.text`` with the offset and length.)
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
entity (MessageEntity): The entity to extract the text from. It must be an entity that
|
entity (telegram.MessageEntity): The entity to extract the text from. It must be an
|
||||||
belongs to this message.
|
entity that belongs to this message.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
str: The text of the given entity
|
str: The text of the given entity
|
||||||
|
|
|
@ -507,8 +507,8 @@ class Message(TelegramObject):
|
||||||
(That is, you can't just slice ``Message.text`` with the offset and length.)
|
(That is, you can't just slice ``Message.text`` with the offset and length.)
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
entity (MessageEntity): The entity to extract the text from. It must be an entity that
|
entity (telegram.MessageEntity): The entity to extract the text from. It must be an
|
||||||
belongs to this message.
|
entity that belongs to this message.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
str: The text of the given entity
|
str: The text of the given entity
|
||||||
|
@ -534,8 +534,8 @@ class Message(TelegramObject):
|
||||||
See ``get_entity_text`` for more info.
|
See ``get_entity_text`` for more info.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
types (Optional[list]): List of ``MessageEntity`` types as strings. If the ``type``
|
types (Optional[list]): List of ``telegram.MessageEntity`` types as strings. If the
|
||||||
attribute of an entity is contained in this list, it will be returned.
|
``type`` attribute of an entity is contained in this list, it will be returned.
|
||||||
Defaults to a list of all types. All types can be found as constants in
|
Defaults to a list of all types. All types can be found as constants in
|
||||||
:class:`telegram.MessageEntity`.
|
:class:`telegram.MessageEntity`.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue