mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2025-03-24 15:59:29 +01:00
26ce9bb343
* Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
145 lines
3.3 KiB
ReStructuredText
145 lines
3.3 KiB
ReStructuredText
.. include:: telegram.ext.rst
|
|
|
|
|
|
telegram package
|
|
================
|
|
|
|
.. toctree::
|
|
|
|
telegram.animation
|
|
telegram.audio
|
|
telegram.bot
|
|
telegram.callbackquery
|
|
telegram.chat
|
|
telegram.chataction
|
|
telegram.chatmember
|
|
telegram.chatphoto
|
|
telegram.constants
|
|
telegram.contact
|
|
telegram.document
|
|
telegram.error
|
|
telegram.file
|
|
telegram.forcereply
|
|
telegram.inlinekeyboardbutton
|
|
telegram.inlinekeyboardmarkup
|
|
telegram.inputfile
|
|
telegram.inputmedia
|
|
telegram.inputmediaanimation
|
|
telegram.inputmediaaudio
|
|
telegram.inputmediadocument
|
|
telegram.inputmediaphoto
|
|
telegram.inputmediavideo
|
|
telegram.keyboardbutton
|
|
telegram.location
|
|
telegram.message
|
|
telegram.messageentity
|
|
telegram.parsemode
|
|
telegram.photosize
|
|
telegram.replykeyboardremove
|
|
telegram.replykeyboardmarkup
|
|
telegram.replymarkup
|
|
telegram.telegramobject
|
|
telegram.update
|
|
telegram.user
|
|
telegram.userprofilephotos
|
|
telegram.venue
|
|
telegram.video
|
|
telegram.videonote
|
|
telegram.voice
|
|
telegram.webhookinfo
|
|
|
|
Stickers
|
|
--------
|
|
|
|
.. toctree::
|
|
|
|
telegram.sticker
|
|
telegram.stickerset
|
|
telegram.maskposition
|
|
|
|
Inline Mode
|
|
-----------
|
|
|
|
.. toctree::
|
|
|
|
telegram.inlinequery
|
|
telegram.inlinequeryresult
|
|
telegram.inlinequeryresultarticle
|
|
telegram.inlinequeryresultaudio
|
|
telegram.inlinequeryresultcachedaudio
|
|
telegram.inlinequeryresultcacheddocument
|
|
telegram.inlinequeryresultcachedgif
|
|
telegram.inlinequeryresultcachedmpeg4gif
|
|
telegram.inlinequeryresultcachedphoto
|
|
telegram.inlinequeryresultcachedsticker
|
|
telegram.inlinequeryresultcachedvideo
|
|
telegram.inlinequeryresultcachedvoice
|
|
telegram.inlinequeryresultcontact
|
|
telegram.inlinequeryresultdocument
|
|
telegram.inlinequeryresultgame
|
|
telegram.inlinequeryresultgif
|
|
telegram.inlinequeryresultlocation
|
|
telegram.inlinequeryresultmpeg4gif
|
|
telegram.inlinequeryresultphoto
|
|
telegram.inlinequeryresultvenue
|
|
telegram.inlinequeryresultvideo
|
|
telegram.inlinequeryresultvoice
|
|
telegram.inputmessagecontent
|
|
telegram.inputtextmessagecontent
|
|
telegram.inputlocationmessagecontent
|
|
telegram.inputvenuemessagecontent
|
|
telegram.inputcontactmessagecontent
|
|
telegram.choseninlineresult
|
|
|
|
Payments
|
|
--------
|
|
|
|
.. toctree::
|
|
|
|
telegram.labeledprice
|
|
telegram.invoice
|
|
telegram.shippingaddress
|
|
telegram.orderinfo
|
|
telegram.shippingoption
|
|
telegram.successfulpayment
|
|
telegram.shippingquery
|
|
telegram.precheckoutquery
|
|
|
|
Games
|
|
-----
|
|
|
|
.. toctree::
|
|
|
|
telegram.game
|
|
telegram.callbackgame
|
|
telegram.gamehighscore
|
|
|
|
Passport
|
|
--------
|
|
|
|
.. toctree::
|
|
|
|
telegram.passportelementerror
|
|
telegram.passportelementerrorfile
|
|
telegram.passportelementerrorreverseside
|
|
telegram.passportelementerrorfrontside
|
|
telegram.passportelementerrorfiles
|
|
telegram.passportelementerrordatafield
|
|
telegram.passportelementerrorfile
|
|
telegram.credentials
|
|
telegram.datacredentials
|
|
telegram.securedata
|
|
telegram.filecredentials
|
|
telegram.iddocumentdata
|
|
telegram.personaldetails
|
|
telegram.residentialaddress
|
|
telegram.passportdata
|
|
telegram.passportfile
|
|
telegram.encryptedpassportelement
|
|
telegram.encryptedcredentials
|
|
|
|
telegram.utils
|
|
--------------
|
|
|
|
.. toctree::
|
|
telegram.utils
|