From 65624b02b1d9da227deaf5767cd1cc3fbb3fc08a Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Sun, 26 Jul 2026 21:34:42 -0400 Subject: [PATCH 1/4] Initial .rst autogeneration code --- .github/CONTRIBUTING.rst | 13 +- .gitignore | 23 ++ docs/auxil/api_docs.py | 344 ++++++++++++++++++ docs/source/_templates/ptb-object.rst | 8 + docs/source/conf.py | 2 + docs/source/telegram.acceptedgifttypes.rst | 6 - docs/source/telegram.affiliateinfo.rst | 6 - docs/source/telegram.animation.rst | 9 - docs/source/telegram.at-tree.rst | 229 +----------- docs/source/telegram.audio.rst | 9 - docs/source/telegram.backgroundfill.rst | 8 - ...elegram.backgroundfillfreeformgradient.rst | 8 - .../telegram.backgroundfillgradient.rst | 8 - docs/source/telegram.backgroundfillsolid.rst | 8 - docs/source/telegram.backgroundtype.rst | 8 - .../telegram.backgroundtypechattheme.rst | 8 - docs/source/telegram.backgroundtypefill.rst | 8 - .../source/telegram.backgroundtypepattern.rst | 8 - .../telegram.backgroundtypewallpaper.rst | 8 - docs/source/telegram.birthdate.rst | 7 - docs/source/telegram.bot.rst | 6 - docs/source/telegram.botaccesssettings.rst | 6 - docs/source/telegram.botcommand.rst | 6 - docs/source/telegram.botcommandscope.rst | 6 - ...m.botcommandscopeallchatadministrators.rst | 6 - .../telegram.botcommandscopeallgroupchats.rst | 6 - ...elegram.botcommandscopeallprivatechats.rst | 6 - docs/source/telegram.botcommandscopechat.rst | 6 - ...gram.botcommandscopechatadministrators.rst | 6 - .../telegram.botcommandscopechatmember.rst | 6 - .../telegram.botcommandscopedefault.rst | 6 - docs/source/telegram.botdescription.rst | 6 - docs/source/telegram.botname.rst | 6 - docs/source/telegram.botshortdescription.rst | 6 - docs/source/telegram.businessbotrights.rst | 6 - docs/source/telegram.businessconnection.rst | 6 - docs/source/telegram.businessintro.rst | 6 - docs/source/telegram.businesslocation.rst | 6 - .../telegram.businessmessagesdeleted.rst | 6 - docs/source/telegram.businessopeninghours.rst | 6 - .../telegram.businessopeninghoursinterval.rst | 6 - docs/source/telegram.callbackgame.rst | 6 - docs/source/telegram.callbackquery.rst | 6 - docs/source/telegram.chat.rst | 8 - .../telegram.chatadministratorrights.rst | 8 - docs/source/telegram.chatbackground.rst | 8 - docs/source/telegram.chatboost.rst | 8 - docs/source/telegram.chatboostadded.rst | 6 - docs/source/telegram.chatboostremoved.rst | 8 - docs/source/telegram.chatboostsource.rst | 8 - .../telegram.chatboostsourcegiftcode.rst | 8 - .../telegram.chatboostsourcegiveaway.rst | 8 - .../telegram.chatboostsourcepremium.rst | 8 - docs/source/telegram.chatboostupdated.rst | 8 - docs/source/telegram.chatfullinfo.rst | 8 - docs/source/telegram.chatinvitelink.rst | 6 - docs/source/telegram.chatjoinrequest.rst | 6 - docs/source/telegram.chatlocation.rst | 6 - docs/source/telegram.chatmember.rst | 6 - .../telegram.chatmemberadministrator.rst | 6 - docs/source/telegram.chatmemberbanned.rst | 6 - docs/source/telegram.chatmemberleft.rst | 6 - docs/source/telegram.chatmembermember.rst | 6 - docs/source/telegram.chatmemberowner.rst | 7 - docs/source/telegram.chatmemberrestricted.rst | 6 - docs/source/telegram.chatmemberupdated.rst | 6 - docs/source/telegram.chatownerchanged.rst | 6 - docs/source/telegram.chatownerleft.rst | 6 - docs/source/telegram.chatpermissions.rst | 6 - docs/source/telegram.chatphoto.rst | 6 - docs/source/telegram.chatshared.rst | 6 - docs/source/telegram.checklist.rst | 6 - docs/source/telegram.checklisttask.rst | 6 - docs/source/telegram.checklisttasksadded.rst | 6 - docs/source/telegram.checklisttasksdone.rst | 6 - docs/source/telegram.choseninlineresult.rst | 6 - docs/source/telegram.contact.rst | 6 - docs/source/telegram.copytextbutton.rst | 6 - docs/source/telegram.credentials.rst | 6 - docs/source/telegram.datacredentials.rst | 6 - docs/source/telegram.dice.rst | 6 - .../telegram.directmessagepricechanged.rst | 6 - docs/source/telegram.directmessagestopic.rst | 6 - docs/source/telegram.document.rst | 8 - docs/source/telegram.encryptedcredentials.rst | 6 - .../telegram.encryptedpassportelement.rst | 6 - docs/source/telegram.ext.aioratelimiter.rst | 6 - docs/source/telegram.ext.application.rst | 6 - .../telegram.ext.applicationbuilder.rst | 5 - .../telegram.ext.applicationhandlerstop.rst | 6 - docs/source/telegram.ext.basehandler.rst | 6 - docs/source/telegram.ext.basepersistence.rst | 6 - docs/source/telegram.ext.baseratelimiter.rst | 6 - .../telegram.ext.baseupdateprocessor.rst | 6 - ...telegram.ext.businessconnectionhandler.rst | 6 - ...ram.ext.businessmessagesdeletedhandler.rst | 6 - docs/source/telegram.ext.callbackcontext.rst | 5 - .../source/telegram.ext.callbackdatacache.rst | 6 - .../telegram.ext.callbackqueryhandler.rst | 6 - docs/source/telegram.ext.chatboosthandler.rst | 8 - .../telegram.ext.chatjoinrequesthandler.rst | 6 - .../source/telegram.ext.chatmemberhandler.rst | 6 - ...telegram.ext.choseninlineresulthandler.rst | 6 - docs/source/telegram.ext.commandhandler.rst | 6 - docs/source/telegram.ext.contexttypes.rst | 6 - .../telegram.ext.conversationhandler.rst | 6 - docs/source/telegram.ext.defaults.rst | 6 - docs/source/telegram.ext.dictpersistence.rst | 6 - docs/source/telegram.ext.extbot.rst | 6 - .../telegram.ext.inlinequeryhandler.rst | 6 - .../telegram.ext.invalidcallbackdata.rst | 6 - docs/source/telegram.ext.job.rst | 6 - docs/source/telegram.ext.jobqueue.rst | 6 - .../telegram.ext.managedbotupdatedhandler.rst | 6 - docs/source/telegram.ext.messagehandler.rst | 6 - .../telegram.ext.messagereactionhandler.rst | 6 - ...telegram.ext.paidmediapurchasedhandler.rst | 6 - docs/source/telegram.ext.persistenceinput.rst | 5 - .../source/telegram.ext.picklepersistence.rst | 6 - .../source/telegram.ext.pollanswerhandler.rst | 6 - docs/source/telegram.ext.pollhandler.rst | 6 - .../telegram.ext.precheckoutqueryhandler.rst | 6 - docs/source/telegram.ext.prefixhandler.rst | 6 - docs/source/telegram.ext.rst | 20 +- .../telegram.ext.shippingqueryhandler.rst | 6 - .../telegram.ext.simpleupdateprocessor.rst | 6 - .../telegram.ext.stringcommandhandler.rst | 6 - .../telegram.ext.stringregexhandler.rst | 6 - docs/source/telegram.ext.typehandler.rst | 6 - docs/source/telegram.ext.updater.rst | 6 - docs/source/telegram.externalreplyinfo.rst | 6 - docs/source/telegram.file.rst | 6 - docs/source/telegram.filecredentials.rst | 6 - docs/source/telegram.forcereply.rst | 6 - docs/source/telegram.forumtopic.rst | 6 - docs/source/telegram.forumtopicclosed.rst | 6 - docs/source/telegram.forumtopiccreated.rst | 6 - docs/source/telegram.forumtopicedited.rst | 6 - docs/source/telegram.forumtopicreopened.rst | 6 - docs/source/telegram.game.rst | 6 - docs/source/telegram.gamehighscore.rst | 6 - .../telegram.generalforumtopichidden.rst | 6 - .../telegram.generalforumtopicunhidden.rst | 6 - docs/source/telegram.gift.rst | 6 - docs/source/telegram.giftbackground.rst | 7 - docs/source/telegram.giftinfo.rst | 7 - docs/source/telegram.gifts.rst | 6 - docs/source/telegram.giveaway.rst | 6 - docs/source/telegram.giveawaycompleted.rst | 6 - docs/source/telegram.giveawaycreated.rst | 6 - docs/source/telegram.giveawaywinners.rst | 6 - docs/source/telegram.iddocumentdata.rst | 6 - docs/source/telegram.inaccessiblemessage.rst | 6 - docs/source/telegram.inlinekeyboardbutton.rst | 6 - docs/source/telegram.inlinekeyboardmarkup.rst | 6 - docs/source/telegram.inlinequery.rst | 6 - docs/source/telegram.inlinequeryresult.rst | 6 - .../telegram.inlinequeryresultarticle.rst | 6 - .../telegram.inlinequeryresultaudio.rst | 6 - .../telegram.inlinequeryresultcachedaudio.rst | 6 - ...legram.inlinequeryresultcacheddocument.rst | 6 - .../telegram.inlinequeryresultcachedgif.rst | 6 - ...legram.inlinequeryresultcachedmpeg4gif.rst | 6 - .../telegram.inlinequeryresultcachedphoto.rst | 6 - ...elegram.inlinequeryresultcachedsticker.rst | 6 - .../telegram.inlinequeryresultcachedvideo.rst | 6 - .../telegram.inlinequeryresultcachedvoice.rst | 6 - .../telegram.inlinequeryresultcontact.rst | 6 - .../telegram.inlinequeryresultdocument.rst | 6 - .../source/telegram.inlinequeryresultgame.rst | 6 - docs/source/telegram.inlinequeryresultgif.rst | 6 - .../telegram.inlinequeryresultlocation.rst | 6 - .../telegram.inlinequeryresultmpeg4gif.rst | 6 - .../telegram.inlinequeryresultphoto.rst | 6 - .../telegram.inlinequeryresultsbutton.rst | 6 - .../telegram.inlinequeryresultvenue.rst | 6 - .../telegram.inlinequeryresultvideo.rst | 6 - .../telegram.inlinequeryresultvoice.rst | 6 - docs/source/telegram.inputchecklist.rst | 6 - docs/source/telegram.inputchecklisttask.rst | 6 - .../telegram.inputcontactmessagecontent.rst | 6 - docs/source/telegram.inputfile.rst | 6 - .../telegram.inputinvoicemessagecontent.rst | 6 - .../telegram.inputlocationmessagecontent.rst | 6 - docs/source/telegram.inputmedia.rst | 6 - docs/source/telegram.inputmediaanimation.rst | 6 - docs/source/telegram.inputmediaaudio.rst | 6 - docs/source/telegram.inputmediadocument.rst | 6 - docs/source/telegram.inputmedialivephoto.rst | 6 - docs/source/telegram.inputmedialocation.rst | 6 - docs/source/telegram.inputmediaphoto.rst | 6 - docs/source/telegram.inputmediasticker.rst | 6 - docs/source/telegram.inputmediavenue.rst | 6 - docs/source/telegram.inputmediavideo.rst | 6 - docs/source/telegram.inputmessagecontent.rst | 6 - docs/source/telegram.inputpaidmedia.rst | 6 - .../telegram.inputpaidmedialivephoto.rst | 6 - docs/source/telegram.inputpaidmediaphoto.rst | 6 - docs/source/telegram.inputpaidmediavideo.rst | 6 - docs/source/telegram.inputpollmedia.rst | 2 + docs/source/telegram.inputpolloption.rst | 6 - docs/source/telegram.inputpolloptionmedia.rst | 2 + docs/source/telegram.inputprofilephoto.rst | 6 - .../telegram.inputprofilephotoanimated.rst | 6 - .../telegram.inputprofilephotostatic.rst | 6 - docs/source/telegram.inputsticker.rst | 6 - docs/source/telegram.inputstorycontent.rst | 6 - .../telegram.inputstorycontentphoto.rst | 6 - .../telegram.inputstorycontentvideo.rst | 6 - .../telegram.inputtextmessagecontent.rst | 6 - .../telegram.inputvenuemessagecontent.rst | 6 - docs/source/telegram.invoice.rst | 6 - docs/source/telegram.keyboardbutton.rst | 6 - .../telegram.keyboardbuttonpolltype.rst | 6 - .../telegram.keyboardbuttonrequestchat.rst | 6 - ...legram.keyboardbuttonrequestmanagedbot.rst | 6 - .../telegram.keyboardbuttonrequestusers.rst | 6 - docs/source/telegram.labeledprice.rst | 6 - docs/source/telegram.linkpreviewoptions.rst | 6 - docs/source/telegram.livephoto.rst | 6 - docs/source/telegram.location.rst | 6 - docs/source/telegram.locationaddress.rst | 6 - docs/source/telegram.loginurl.rst | 6 - docs/source/telegram.managedbotcreated.rst | 6 - docs/source/telegram.managedbotupdated.rst | 6 - docs/source/telegram.maskposition.rst | 6 - .../telegram.maybeinaccessiblemessage.rst | 6 - docs/source/telegram.menubutton.rst | 6 - docs/source/telegram.menubuttoncommands.rst | 6 - docs/source/telegram.menubuttondefault.rst | 6 - docs/source/telegram.menubuttonwebapp.rst | 6 - docs/source/telegram.message.rst | 6 - ...telegram.messageautodeletetimerchanged.rst | 6 - docs/source/telegram.messageentity.rst | 6 - docs/source/telegram.messageid.rst | 6 - docs/source/telegram.messageorigin.rst | 6 - docs/source/telegram.messageoriginchannel.rst | 6 - docs/source/telegram.messageoriginchat.rst | 6 - .../telegram.messageoriginhiddenuser.rst | 7 - docs/source/telegram.messageoriginuser.rst | 6 - .../telegram.messagereactioncountupdated.rst | 6 - .../telegram.messagereactionupdated.rst | 6 - docs/source/telegram.orderinfo.rst | 6 - docs/source/telegram.ownedgift.rst | 6 - docs/source/telegram.ownedgiftregular.rst | 6 - docs/source/telegram.ownedgifts.rst | 6 - docs/source/telegram.ownedgiftunique.rst | 6 - docs/source/telegram.paidmedia.rst | 6 - docs/source/telegram.paidmediainfo.rst | 6 - docs/source/telegram.paidmedialivephoto.rst | 6 - docs/source/telegram.paidmediaphoto.rst | 6 - docs/source/telegram.paidmediapreview.rst | 6 - docs/source/telegram.paidmediapurchased.rst | 6 - docs/source/telegram.paidmediavideo.rst | 6 - .../telegram.paidmessagepricechanged.rst | 6 - docs/source/telegram.passportdata.rst | 6 - docs/source/telegram.passportelementerror.rst | 6 - ...telegram.passportelementerrordatafield.rst | 6 - .../telegram.passportelementerrorfile.rst | 6 - .../telegram.passportelementerrorfiles.rst | 6 - ...telegram.passportelementerrorfrontside.rst | 6 - ...legram.passportelementerrorreverseside.rst | 6 - .../telegram.passportelementerrorselfie.rst | 6 - ...am.passportelementerrortranslationfile.rst | 6 - ...m.passportelementerrortranslationfiles.rst | 6 - ...legram.passportelementerrorunspecified.rst | 6 - docs/source/telegram.passportfile.rst | 6 - docs/source/telegram.personaldetails.rst | 6 - docs/source/telegram.photosize.rst | 8 - docs/source/telegram.poll.rst | 6 - docs/source/telegram.pollanswer.rst | 6 - docs/source/telegram.pollmedia.rst | 6 - docs/source/telegram.polloption.rst | 6 - docs/source/telegram.polloptionadded.rst | 6 - docs/source/telegram.polloptiondeleted.rst | 6 - docs/source/telegram.precheckoutquery.rst | 6 - .../source/telegram.preparedinlinemessage.rst | 6 - .../telegram.preparedkeyboardbutton.rst | 6 - .../telegram.proximityalerttriggered.rst | 6 - docs/source/telegram.reactioncount.rst | 6 - docs/source/telegram.reactiontype.rst | 6 - .../telegram.reactiontypecustomemoji.rst | 6 - docs/source/telegram.reactiontypeemoji.rst | 6 - docs/source/telegram.reactiontypepaid.rst | 6 - docs/source/telegram.refundedpayment.rst | 6 - docs/source/telegram.replykeyboardmarkup.rst | 6 - docs/source/telegram.replykeyboardremove.rst | 6 - docs/source/telegram.replyparameters.rst | 6 - docs/source/telegram.request.baserequest.rst | 6 - docs/source/telegram.request.httpxrequest.rst | 6 - docs/source/telegram.request.requestdata.rst | 6 - docs/source/telegram.request.rst | 7 +- docs/source/telegram.residentialaddress.rst | 6 - .../telegram.revenuewithdrawalstate.rst | 6 - .../telegram.revenuewithdrawalstatefailed.rst | 6 - ...telegram.revenuewithdrawalstatepending.rst | 6 - ...legram.revenuewithdrawalstatesucceeded.rst | 6 - docs/source/telegram.securedata.rst | 6 - docs/source/telegram.securevalue.rst | 6 - docs/source/telegram.sentguestmessage.rst | 6 - docs/source/telegram.sentwebappmessage.rst | 6 - docs/source/telegram.shareduser.rst | 7 - docs/source/telegram.shippingaddress.rst | 6 - docs/source/telegram.shippingoption.rst | 6 - docs/source/telegram.shippingquery.rst | 6 - docs/source/telegram.staramount.rst | 6 - docs/source/telegram.startransaction.rst | 6 - docs/source/telegram.startransactions.rst | 7 - docs/source/telegram.sticker.rst | 9 - docs/source/telegram.stickerset.rst | 6 - docs/source/telegram.story.rst | 6 - docs/source/telegram.storyarea.rst | 6 - docs/source/telegram.storyareaposition.rst | 6 - docs/source/telegram.storyareatype.rst | 6 - docs/source/telegram.storyareatypelink.rst | 6 - .../source/telegram.storyareatypelocation.rst | 6 - ...elegram.storyareatypesuggestedreaction.rst | 6 - .../telegram.storyareatypeuniquegift.rst | 6 - docs/source/telegram.storyareatypeweather.rst | 6 - docs/source/telegram.successfulpayment.rst | 6 - .../telegram.suggestedpostapprovalfailed.rst | 6 - .../source/telegram.suggestedpostapproved.rst | 6 - .../source/telegram.suggestedpostdeclined.rst | 6 - docs/source/telegram.suggestedpostinfo.rst | 6 - docs/source/telegram.suggestedpostpaid.rst | 6 - .../telegram.suggestedpostparameters.rst | 6 - docs/source/telegram.suggestedpostprice.rst | 6 - .../source/telegram.suggestedpostrefunded.rst | 6 - .../telegram.switchinlinequerychosenchat.rst | 6 - docs/source/telegram.telegramobject.rst | 6 - docs/source/telegram.textquote.rst | 6 - docs/source/telegram.transactionpartner.rst | 6 - ...ram.transactionpartneraffiliateprogram.rst | 6 - .../telegram.transactionpartnerchat.rst | 6 - .../telegram.transactionpartnerfragment.rst | 6 - .../telegram.transactionpartnerother.rst | 6 - ...telegram.transactionpartnertelegramads.rst | 6 - ...telegram.transactionpartnertelegramapi.rst | 6 - .../telegram.transactionpartneruser.rst | 6 - docs/source/telegram.uniquegift.rst | 7 - docs/source/telegram.uniquegiftbackdrop.rst | 7 - .../telegram.uniquegiftbackdropcolors.rst | 7 - docs/source/telegram.uniquegiftcolors.rst | 7 - docs/source/telegram.uniquegiftinfo.rst | 7 - docs/source/telegram.uniquegiftmodel.rst | 7 - docs/source/telegram.uniquegiftsymbol.rst | 7 - docs/source/telegram.update.rst | 6 - docs/source/telegram.user.rst | 6 - docs/source/telegram.userchatboosts.rst | 8 - docs/source/telegram.userprofileaudios.rst | 6 - docs/source/telegram.userprofilephotos.rst | 6 - docs/source/telegram.userrating.rst | 6 - docs/source/telegram.usersshared.rst | 6 - docs/source/telegram.venue.rst | 6 - docs/source/telegram.video.rst | 9 - docs/source/telegram.videochatended.rst | 7 - .../telegram.videochatparticipantsinvited.rst | 7 - docs/source/telegram.videochatscheduled.rst | 6 - docs/source/telegram.videochatstarted.rst | 7 - docs/source/telegram.videonote.rst | 9 - docs/source/telegram.videoquality.rst | 8 - docs/source/telegram.voice.rst | 9 - docs/source/telegram.webappdata.rst | 6 - docs/source/telegram.webappinfo.rst | 6 - docs/source/telegram.webhookinfo.rst | 6 - docs/source/telegram.writeaccessallowed.rst | 6 - src/telegram/_chatboost.py | 2 + 367 files changed, 398 insertions(+), 2472 deletions(-) create mode 100644 docs/auxil/api_docs.py create mode 100644 docs/source/_templates/ptb-object.rst delete mode 100644 docs/source/telegram.acceptedgifttypes.rst delete mode 100644 docs/source/telegram.affiliateinfo.rst delete mode 100644 docs/source/telegram.animation.rst delete mode 100644 docs/source/telegram.audio.rst delete mode 100644 docs/source/telegram.backgroundfill.rst delete mode 100644 docs/source/telegram.backgroundfillfreeformgradient.rst delete mode 100644 docs/source/telegram.backgroundfillgradient.rst delete mode 100644 docs/source/telegram.backgroundfillsolid.rst delete mode 100644 docs/source/telegram.backgroundtype.rst delete mode 100644 docs/source/telegram.backgroundtypechattheme.rst delete mode 100644 docs/source/telegram.backgroundtypefill.rst delete mode 100644 docs/source/telegram.backgroundtypepattern.rst delete mode 100644 docs/source/telegram.backgroundtypewallpaper.rst delete mode 100644 docs/source/telegram.birthdate.rst delete mode 100644 docs/source/telegram.bot.rst delete mode 100644 docs/source/telegram.botaccesssettings.rst delete mode 100644 docs/source/telegram.botcommand.rst delete mode 100644 docs/source/telegram.botcommandscope.rst delete mode 100644 docs/source/telegram.botcommandscopeallchatadministrators.rst delete mode 100644 docs/source/telegram.botcommandscopeallgroupchats.rst delete mode 100644 docs/source/telegram.botcommandscopeallprivatechats.rst delete mode 100644 docs/source/telegram.botcommandscopechat.rst delete mode 100644 docs/source/telegram.botcommandscopechatadministrators.rst delete mode 100644 docs/source/telegram.botcommandscopechatmember.rst delete mode 100644 docs/source/telegram.botcommandscopedefault.rst delete mode 100644 docs/source/telegram.botdescription.rst delete mode 100644 docs/source/telegram.botname.rst delete mode 100644 docs/source/telegram.botshortdescription.rst delete mode 100644 docs/source/telegram.businessbotrights.rst delete mode 100644 docs/source/telegram.businessconnection.rst delete mode 100644 docs/source/telegram.businessintro.rst delete mode 100644 docs/source/telegram.businesslocation.rst delete mode 100644 docs/source/telegram.businessmessagesdeleted.rst delete mode 100644 docs/source/telegram.businessopeninghours.rst delete mode 100644 docs/source/telegram.businessopeninghoursinterval.rst delete mode 100644 docs/source/telegram.callbackgame.rst delete mode 100644 docs/source/telegram.callbackquery.rst delete mode 100644 docs/source/telegram.chat.rst delete mode 100644 docs/source/telegram.chatadministratorrights.rst delete mode 100644 docs/source/telegram.chatbackground.rst delete mode 100644 docs/source/telegram.chatboost.rst delete mode 100644 docs/source/telegram.chatboostadded.rst delete mode 100644 docs/source/telegram.chatboostremoved.rst delete mode 100644 docs/source/telegram.chatboostsource.rst delete mode 100644 docs/source/telegram.chatboostsourcegiftcode.rst delete mode 100644 docs/source/telegram.chatboostsourcegiveaway.rst delete mode 100644 docs/source/telegram.chatboostsourcepremium.rst delete mode 100644 docs/source/telegram.chatboostupdated.rst delete mode 100644 docs/source/telegram.chatfullinfo.rst delete mode 100644 docs/source/telegram.chatinvitelink.rst delete mode 100644 docs/source/telegram.chatjoinrequest.rst delete mode 100644 docs/source/telegram.chatlocation.rst delete mode 100644 docs/source/telegram.chatmember.rst delete mode 100644 docs/source/telegram.chatmemberadministrator.rst delete mode 100644 docs/source/telegram.chatmemberbanned.rst delete mode 100644 docs/source/telegram.chatmemberleft.rst delete mode 100644 docs/source/telegram.chatmembermember.rst delete mode 100644 docs/source/telegram.chatmemberowner.rst delete mode 100644 docs/source/telegram.chatmemberrestricted.rst delete mode 100644 docs/source/telegram.chatmemberupdated.rst delete mode 100644 docs/source/telegram.chatownerchanged.rst delete mode 100644 docs/source/telegram.chatownerleft.rst delete mode 100644 docs/source/telegram.chatpermissions.rst delete mode 100644 docs/source/telegram.chatphoto.rst delete mode 100644 docs/source/telegram.chatshared.rst delete mode 100644 docs/source/telegram.checklist.rst delete mode 100644 docs/source/telegram.checklisttask.rst delete mode 100644 docs/source/telegram.checklisttasksadded.rst delete mode 100644 docs/source/telegram.checklisttasksdone.rst delete mode 100644 docs/source/telegram.choseninlineresult.rst delete mode 100644 docs/source/telegram.contact.rst delete mode 100644 docs/source/telegram.copytextbutton.rst delete mode 100644 docs/source/telegram.credentials.rst delete mode 100644 docs/source/telegram.datacredentials.rst delete mode 100644 docs/source/telegram.dice.rst delete mode 100644 docs/source/telegram.directmessagepricechanged.rst delete mode 100644 docs/source/telegram.directmessagestopic.rst delete mode 100644 docs/source/telegram.document.rst delete mode 100644 docs/source/telegram.encryptedcredentials.rst delete mode 100644 docs/source/telegram.encryptedpassportelement.rst delete mode 100644 docs/source/telegram.ext.aioratelimiter.rst delete mode 100644 docs/source/telegram.ext.application.rst delete mode 100644 docs/source/telegram.ext.applicationbuilder.rst delete mode 100644 docs/source/telegram.ext.applicationhandlerstop.rst delete mode 100644 docs/source/telegram.ext.basehandler.rst delete mode 100644 docs/source/telegram.ext.basepersistence.rst delete mode 100644 docs/source/telegram.ext.baseratelimiter.rst delete mode 100644 docs/source/telegram.ext.baseupdateprocessor.rst delete mode 100644 docs/source/telegram.ext.businessconnectionhandler.rst delete mode 100644 docs/source/telegram.ext.businessmessagesdeletedhandler.rst delete mode 100644 docs/source/telegram.ext.callbackcontext.rst delete mode 100644 docs/source/telegram.ext.callbackdatacache.rst delete mode 100644 docs/source/telegram.ext.callbackqueryhandler.rst delete mode 100644 docs/source/telegram.ext.chatboosthandler.rst delete mode 100644 docs/source/telegram.ext.chatjoinrequesthandler.rst delete mode 100644 docs/source/telegram.ext.chatmemberhandler.rst delete mode 100644 docs/source/telegram.ext.choseninlineresulthandler.rst delete mode 100644 docs/source/telegram.ext.commandhandler.rst delete mode 100644 docs/source/telegram.ext.contexttypes.rst delete mode 100644 docs/source/telegram.ext.conversationhandler.rst delete mode 100644 docs/source/telegram.ext.defaults.rst delete mode 100644 docs/source/telegram.ext.dictpersistence.rst delete mode 100644 docs/source/telegram.ext.extbot.rst delete mode 100644 docs/source/telegram.ext.inlinequeryhandler.rst delete mode 100644 docs/source/telegram.ext.invalidcallbackdata.rst delete mode 100644 docs/source/telegram.ext.job.rst delete mode 100644 docs/source/telegram.ext.jobqueue.rst delete mode 100644 docs/source/telegram.ext.managedbotupdatedhandler.rst delete mode 100644 docs/source/telegram.ext.messagehandler.rst delete mode 100644 docs/source/telegram.ext.messagereactionhandler.rst delete mode 100644 docs/source/telegram.ext.paidmediapurchasedhandler.rst delete mode 100644 docs/source/telegram.ext.persistenceinput.rst delete mode 100644 docs/source/telegram.ext.picklepersistence.rst delete mode 100644 docs/source/telegram.ext.pollanswerhandler.rst delete mode 100644 docs/source/telegram.ext.pollhandler.rst delete mode 100644 docs/source/telegram.ext.precheckoutqueryhandler.rst delete mode 100644 docs/source/telegram.ext.prefixhandler.rst delete mode 100644 docs/source/telegram.ext.shippingqueryhandler.rst delete mode 100644 docs/source/telegram.ext.simpleupdateprocessor.rst delete mode 100644 docs/source/telegram.ext.stringcommandhandler.rst delete mode 100644 docs/source/telegram.ext.stringregexhandler.rst delete mode 100644 docs/source/telegram.ext.typehandler.rst delete mode 100644 docs/source/telegram.ext.updater.rst delete mode 100644 docs/source/telegram.externalreplyinfo.rst delete mode 100644 docs/source/telegram.file.rst delete mode 100644 docs/source/telegram.filecredentials.rst delete mode 100644 docs/source/telegram.forcereply.rst delete mode 100644 docs/source/telegram.forumtopic.rst delete mode 100644 docs/source/telegram.forumtopicclosed.rst delete mode 100644 docs/source/telegram.forumtopiccreated.rst delete mode 100644 docs/source/telegram.forumtopicedited.rst delete mode 100644 docs/source/telegram.forumtopicreopened.rst delete mode 100644 docs/source/telegram.game.rst delete mode 100644 docs/source/telegram.gamehighscore.rst delete mode 100644 docs/source/telegram.generalforumtopichidden.rst delete mode 100644 docs/source/telegram.generalforumtopicunhidden.rst delete mode 100644 docs/source/telegram.gift.rst delete mode 100644 docs/source/telegram.giftbackground.rst delete mode 100644 docs/source/telegram.giftinfo.rst delete mode 100644 docs/source/telegram.gifts.rst delete mode 100644 docs/source/telegram.giveaway.rst delete mode 100644 docs/source/telegram.giveawaycompleted.rst delete mode 100644 docs/source/telegram.giveawaycreated.rst delete mode 100644 docs/source/telegram.giveawaywinners.rst delete mode 100644 docs/source/telegram.iddocumentdata.rst delete mode 100644 docs/source/telegram.inaccessiblemessage.rst delete mode 100644 docs/source/telegram.inlinekeyboardbutton.rst delete mode 100644 docs/source/telegram.inlinekeyboardmarkup.rst delete mode 100644 docs/source/telegram.inlinequery.rst delete mode 100644 docs/source/telegram.inlinequeryresult.rst delete mode 100644 docs/source/telegram.inlinequeryresultarticle.rst delete mode 100644 docs/source/telegram.inlinequeryresultaudio.rst delete mode 100644 docs/source/telegram.inlinequeryresultcachedaudio.rst delete mode 100644 docs/source/telegram.inlinequeryresultcacheddocument.rst delete mode 100644 docs/source/telegram.inlinequeryresultcachedgif.rst delete mode 100644 docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst delete mode 100644 docs/source/telegram.inlinequeryresultcachedphoto.rst delete mode 100644 docs/source/telegram.inlinequeryresultcachedsticker.rst delete mode 100644 docs/source/telegram.inlinequeryresultcachedvideo.rst delete mode 100644 docs/source/telegram.inlinequeryresultcachedvoice.rst delete mode 100644 docs/source/telegram.inlinequeryresultcontact.rst delete mode 100644 docs/source/telegram.inlinequeryresultdocument.rst delete mode 100644 docs/source/telegram.inlinequeryresultgame.rst delete mode 100644 docs/source/telegram.inlinequeryresultgif.rst delete mode 100644 docs/source/telegram.inlinequeryresultlocation.rst delete mode 100644 docs/source/telegram.inlinequeryresultmpeg4gif.rst delete mode 100644 docs/source/telegram.inlinequeryresultphoto.rst delete mode 100644 docs/source/telegram.inlinequeryresultsbutton.rst delete mode 100644 docs/source/telegram.inlinequeryresultvenue.rst delete mode 100644 docs/source/telegram.inlinequeryresultvideo.rst delete mode 100644 docs/source/telegram.inlinequeryresultvoice.rst delete mode 100644 docs/source/telegram.inputchecklist.rst delete mode 100644 docs/source/telegram.inputchecklisttask.rst delete mode 100644 docs/source/telegram.inputcontactmessagecontent.rst delete mode 100644 docs/source/telegram.inputfile.rst delete mode 100644 docs/source/telegram.inputinvoicemessagecontent.rst delete mode 100644 docs/source/telegram.inputlocationmessagecontent.rst delete mode 100644 docs/source/telegram.inputmedia.rst delete mode 100644 docs/source/telegram.inputmediaanimation.rst delete mode 100644 docs/source/telegram.inputmediaaudio.rst delete mode 100644 docs/source/telegram.inputmediadocument.rst delete mode 100644 docs/source/telegram.inputmedialivephoto.rst delete mode 100644 docs/source/telegram.inputmedialocation.rst delete mode 100644 docs/source/telegram.inputmediaphoto.rst delete mode 100644 docs/source/telegram.inputmediasticker.rst delete mode 100644 docs/source/telegram.inputmediavenue.rst delete mode 100644 docs/source/telegram.inputmediavideo.rst delete mode 100644 docs/source/telegram.inputmessagecontent.rst delete mode 100644 docs/source/telegram.inputpaidmedia.rst delete mode 100644 docs/source/telegram.inputpaidmedialivephoto.rst delete mode 100644 docs/source/telegram.inputpaidmediaphoto.rst delete mode 100644 docs/source/telegram.inputpaidmediavideo.rst delete mode 100644 docs/source/telegram.inputpolloption.rst delete mode 100644 docs/source/telegram.inputprofilephoto.rst delete mode 100644 docs/source/telegram.inputprofilephotoanimated.rst delete mode 100644 docs/source/telegram.inputprofilephotostatic.rst delete mode 100644 docs/source/telegram.inputsticker.rst delete mode 100644 docs/source/telegram.inputstorycontent.rst delete mode 100644 docs/source/telegram.inputstorycontentphoto.rst delete mode 100644 docs/source/telegram.inputstorycontentvideo.rst delete mode 100644 docs/source/telegram.inputtextmessagecontent.rst delete mode 100644 docs/source/telegram.inputvenuemessagecontent.rst delete mode 100644 docs/source/telegram.invoice.rst delete mode 100644 docs/source/telegram.keyboardbutton.rst delete mode 100644 docs/source/telegram.keyboardbuttonpolltype.rst delete mode 100644 docs/source/telegram.keyboardbuttonrequestchat.rst delete mode 100644 docs/source/telegram.keyboardbuttonrequestmanagedbot.rst delete mode 100644 docs/source/telegram.keyboardbuttonrequestusers.rst delete mode 100644 docs/source/telegram.labeledprice.rst delete mode 100644 docs/source/telegram.linkpreviewoptions.rst delete mode 100644 docs/source/telegram.livephoto.rst delete mode 100644 docs/source/telegram.location.rst delete mode 100644 docs/source/telegram.locationaddress.rst delete mode 100644 docs/source/telegram.loginurl.rst delete mode 100644 docs/source/telegram.managedbotcreated.rst delete mode 100644 docs/source/telegram.managedbotupdated.rst delete mode 100644 docs/source/telegram.maskposition.rst delete mode 100644 docs/source/telegram.maybeinaccessiblemessage.rst delete mode 100644 docs/source/telegram.menubutton.rst delete mode 100644 docs/source/telegram.menubuttoncommands.rst delete mode 100644 docs/source/telegram.menubuttondefault.rst delete mode 100644 docs/source/telegram.menubuttonwebapp.rst delete mode 100644 docs/source/telegram.message.rst delete mode 100644 docs/source/telegram.messageautodeletetimerchanged.rst delete mode 100644 docs/source/telegram.messageentity.rst delete mode 100644 docs/source/telegram.messageid.rst delete mode 100644 docs/source/telegram.messageorigin.rst delete mode 100644 docs/source/telegram.messageoriginchannel.rst delete mode 100644 docs/source/telegram.messageoriginchat.rst delete mode 100644 docs/source/telegram.messageoriginhiddenuser.rst delete mode 100644 docs/source/telegram.messageoriginuser.rst delete mode 100644 docs/source/telegram.messagereactioncountupdated.rst delete mode 100644 docs/source/telegram.messagereactionupdated.rst delete mode 100644 docs/source/telegram.orderinfo.rst delete mode 100644 docs/source/telegram.ownedgift.rst delete mode 100644 docs/source/telegram.ownedgiftregular.rst delete mode 100644 docs/source/telegram.ownedgifts.rst delete mode 100644 docs/source/telegram.ownedgiftunique.rst delete mode 100644 docs/source/telegram.paidmedia.rst delete mode 100644 docs/source/telegram.paidmediainfo.rst delete mode 100644 docs/source/telegram.paidmedialivephoto.rst delete mode 100644 docs/source/telegram.paidmediaphoto.rst delete mode 100644 docs/source/telegram.paidmediapreview.rst delete mode 100644 docs/source/telegram.paidmediapurchased.rst delete mode 100644 docs/source/telegram.paidmediavideo.rst delete mode 100644 docs/source/telegram.paidmessagepricechanged.rst delete mode 100644 docs/source/telegram.passportdata.rst delete mode 100644 docs/source/telegram.passportelementerror.rst delete mode 100644 docs/source/telegram.passportelementerrordatafield.rst delete mode 100644 docs/source/telegram.passportelementerrorfile.rst delete mode 100644 docs/source/telegram.passportelementerrorfiles.rst delete mode 100644 docs/source/telegram.passportelementerrorfrontside.rst delete mode 100644 docs/source/telegram.passportelementerrorreverseside.rst delete mode 100644 docs/source/telegram.passportelementerrorselfie.rst delete mode 100644 docs/source/telegram.passportelementerrortranslationfile.rst delete mode 100644 docs/source/telegram.passportelementerrortranslationfiles.rst delete mode 100644 docs/source/telegram.passportelementerrorunspecified.rst delete mode 100644 docs/source/telegram.passportfile.rst delete mode 100644 docs/source/telegram.personaldetails.rst delete mode 100644 docs/source/telegram.photosize.rst delete mode 100644 docs/source/telegram.poll.rst delete mode 100644 docs/source/telegram.pollanswer.rst delete mode 100644 docs/source/telegram.pollmedia.rst delete mode 100644 docs/source/telegram.polloption.rst delete mode 100644 docs/source/telegram.polloptionadded.rst delete mode 100644 docs/source/telegram.polloptiondeleted.rst delete mode 100644 docs/source/telegram.precheckoutquery.rst delete mode 100644 docs/source/telegram.preparedinlinemessage.rst delete mode 100644 docs/source/telegram.preparedkeyboardbutton.rst delete mode 100644 docs/source/telegram.proximityalerttriggered.rst delete mode 100644 docs/source/telegram.reactioncount.rst delete mode 100644 docs/source/telegram.reactiontype.rst delete mode 100644 docs/source/telegram.reactiontypecustomemoji.rst delete mode 100644 docs/source/telegram.reactiontypeemoji.rst delete mode 100644 docs/source/telegram.reactiontypepaid.rst delete mode 100644 docs/source/telegram.refundedpayment.rst delete mode 100644 docs/source/telegram.replykeyboardmarkup.rst delete mode 100644 docs/source/telegram.replykeyboardremove.rst delete mode 100644 docs/source/telegram.replyparameters.rst delete mode 100644 docs/source/telegram.request.baserequest.rst delete mode 100644 docs/source/telegram.request.httpxrequest.rst delete mode 100644 docs/source/telegram.request.requestdata.rst delete mode 100644 docs/source/telegram.residentialaddress.rst delete mode 100644 docs/source/telegram.revenuewithdrawalstate.rst delete mode 100644 docs/source/telegram.revenuewithdrawalstatefailed.rst delete mode 100644 docs/source/telegram.revenuewithdrawalstatepending.rst delete mode 100644 docs/source/telegram.revenuewithdrawalstatesucceeded.rst delete mode 100644 docs/source/telegram.securedata.rst delete mode 100644 docs/source/telegram.securevalue.rst delete mode 100644 docs/source/telegram.sentguestmessage.rst delete mode 100644 docs/source/telegram.sentwebappmessage.rst delete mode 100644 docs/source/telegram.shareduser.rst delete mode 100644 docs/source/telegram.shippingaddress.rst delete mode 100644 docs/source/telegram.shippingoption.rst delete mode 100644 docs/source/telegram.shippingquery.rst delete mode 100644 docs/source/telegram.staramount.rst delete mode 100644 docs/source/telegram.startransaction.rst delete mode 100644 docs/source/telegram.startransactions.rst delete mode 100644 docs/source/telegram.sticker.rst delete mode 100644 docs/source/telegram.stickerset.rst delete mode 100644 docs/source/telegram.story.rst delete mode 100644 docs/source/telegram.storyarea.rst delete mode 100644 docs/source/telegram.storyareaposition.rst delete mode 100644 docs/source/telegram.storyareatype.rst delete mode 100644 docs/source/telegram.storyareatypelink.rst delete mode 100644 docs/source/telegram.storyareatypelocation.rst delete mode 100644 docs/source/telegram.storyareatypesuggestedreaction.rst delete mode 100644 docs/source/telegram.storyareatypeuniquegift.rst delete mode 100644 docs/source/telegram.storyareatypeweather.rst delete mode 100644 docs/source/telegram.successfulpayment.rst delete mode 100644 docs/source/telegram.suggestedpostapprovalfailed.rst delete mode 100644 docs/source/telegram.suggestedpostapproved.rst delete mode 100644 docs/source/telegram.suggestedpostdeclined.rst delete mode 100644 docs/source/telegram.suggestedpostinfo.rst delete mode 100644 docs/source/telegram.suggestedpostpaid.rst delete mode 100644 docs/source/telegram.suggestedpostparameters.rst delete mode 100644 docs/source/telegram.suggestedpostprice.rst delete mode 100644 docs/source/telegram.suggestedpostrefunded.rst delete mode 100644 docs/source/telegram.switchinlinequerychosenchat.rst delete mode 100644 docs/source/telegram.telegramobject.rst delete mode 100644 docs/source/telegram.textquote.rst delete mode 100644 docs/source/telegram.transactionpartner.rst delete mode 100644 docs/source/telegram.transactionpartneraffiliateprogram.rst delete mode 100644 docs/source/telegram.transactionpartnerchat.rst delete mode 100644 docs/source/telegram.transactionpartnerfragment.rst delete mode 100644 docs/source/telegram.transactionpartnerother.rst delete mode 100644 docs/source/telegram.transactionpartnertelegramads.rst delete mode 100644 docs/source/telegram.transactionpartnertelegramapi.rst delete mode 100644 docs/source/telegram.transactionpartneruser.rst delete mode 100644 docs/source/telegram.uniquegift.rst delete mode 100644 docs/source/telegram.uniquegiftbackdrop.rst delete mode 100644 docs/source/telegram.uniquegiftbackdropcolors.rst delete mode 100644 docs/source/telegram.uniquegiftcolors.rst delete mode 100644 docs/source/telegram.uniquegiftinfo.rst delete mode 100644 docs/source/telegram.uniquegiftmodel.rst delete mode 100644 docs/source/telegram.uniquegiftsymbol.rst delete mode 100644 docs/source/telegram.update.rst delete mode 100644 docs/source/telegram.user.rst delete mode 100644 docs/source/telegram.userchatboosts.rst delete mode 100644 docs/source/telegram.userprofileaudios.rst delete mode 100644 docs/source/telegram.userprofilephotos.rst delete mode 100644 docs/source/telegram.userrating.rst delete mode 100644 docs/source/telegram.usersshared.rst delete mode 100644 docs/source/telegram.venue.rst delete mode 100644 docs/source/telegram.video.rst delete mode 100644 docs/source/telegram.videochatended.rst delete mode 100644 docs/source/telegram.videochatparticipantsinvited.rst delete mode 100644 docs/source/telegram.videochatscheduled.rst delete mode 100644 docs/source/telegram.videochatstarted.rst delete mode 100644 docs/source/telegram.videonote.rst delete mode 100644 docs/source/telegram.videoquality.rst delete mode 100644 docs/source/telegram.voice.rst delete mode 100644 docs/source/telegram.webappdata.rst delete mode 100644 docs/source/telegram.webappinfo.rst delete mode 100644 docs/source/telegram.webhookinfo.rst delete mode 100644 docs/source/telegram.writeaccessallowed.rst diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index cd6871452a2..91a0d7337ec 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -169,7 +169,7 @@ Feel free to copy (parts of) the checklist to the PR description to remind you o - [ ] Created new or adapted existing unit tests - [ ] Documented code changes according to the [CSI standard](https://standards.mousepawmedia.com/en/stable/csi.html) - [ ] Added myself alphabetically to `AUTHORS.rst` (optional) - - [ ] Added new classes & modules to the docs and all suitable ``__all__`` s + - [ ] Added new public classes to all suitable ``__all__`` s (their API pages are generated automatically) and new modules to the docs - [ ] Checked the [Stability Policy](https://docs.python-telegram-bot.org/stability_policy.html) in case of deprecations or changes to documented behavior **If the PR contains API changes (otherwise, you can ignore this passage)** @@ -231,7 +231,18 @@ or, if you don't have ``make`` available (e.g. on Windows): Once the process terminates, you can view the built documentation by opening ``docs/build/html/index.html`` with a browser. +- Reference pages for public objects exported in the ``__all__`` of ``telegram``, ``telegram.ext`` and + ``telegram.request`` are generated automatically during the Sphinx build. Do not add a + ``docs/source/telegram..rst`` file for a normal class. New objects are added to their + package's default toctree automatically. To list an object in one of the specialized sections + instead, add its lower-case document name to the corresponding ``*-tree.rst`` file. + An object that cannot be rendered correctly by the shared template may keep a manual RST page. + Such a page must start with the manual-page marker defined in ``docs/auxil/api_docs.py`` and be + explicitly unignored in ``.gitignore``. Rare custom autodoc options are also configured in + ``docs/auxil/api_docs.py``. + - Add ``.. versionadded:: NEXT.VERSION``, ``.. versionchanged:: NEXT.VERSION`` or ``.. deprecated:: NEXT.VERSION`` to the associated documentation of your changes, depending on what kind of change you made. This only applies if the change you made is visible to an end user. The directives should be added to class/method descriptions if their general behaviour changed and to the description of all arguments & attributes that changed. + For a new class, put ``.. versionadded:: NEXT.VERSION`` in the class docstring. Dev facing documentation ------------------------ diff --git a/.gitignore b/.gitignore index 01c2cfda73f..cc800e8715c 100644 --- a/.gitignore +++ b/.gitignore @@ -64,6 +64,29 @@ coverage.xml # Sphinx documentation docs/_build/ +# Transient API pages generated by docs.auxil.api_docs +/docs/source/telegram.*.rst +!/docs/source/telegram.rst +!/docs/source/telegram.at-tree.rst +!/docs/source/telegram.constants.rst +!/docs/source/telegram.error.rst +!/docs/source/telegram.ext.acd-tree.rst +!/docs/source/telegram.ext.filters.rst +!/docs/source/telegram.ext.handlers-tree.rst +!/docs/source/telegram.ext.persistence-tree.rst +!/docs/source/telegram.ext.rate-limiting-tree.rst +!/docs/source/telegram.ext.rst +!/docs/source/telegram.games-tree.rst +!/docs/source/telegram.helpers.rst +!/docs/source/telegram.inline-tree.rst +!/docs/source/telegram.passport-tree.rst +!/docs/source/telegram.payments-tree.rst +!/docs/source/telegram.request.rst +!/docs/source/telegram.stickers-tree.rst +!/docs/source/telegram.warnings.rst +!/docs/source/telegram.inputpollmedia.rst +!/docs/source/telegram.inputpolloptionmedia.rst + # PyBuilder target/ .idea/ diff --git a/docs/auxil/api_docs.py b/docs/auxil/api_docs.py new file mode 100644 index 00000000000..85b1f7993bc --- /dev/null +++ b/docs/auxil/api_docs.py @@ -0,0 +1,344 @@ +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2026 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/]. +"""Generate the public API reference from PTB's ``__all__`` exports. + +Sphinx's autosummary extension can generate one source document per object, but it normally expects +the object list to be maintained in an RST file. This extension builds that list from PTB's public +exports instead and removes the generated sources when the build finishes. + +Relevant Sphinx documentation: + +* Autosummary: https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html +* Custom templates: https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html#customizing-templates +* Sphinx events: https://www.sphinx-doc.org/en/master/extdev/event_callbacks.html +""" + +from __future__ import annotations + +import tempfile +from collections import Counter +from importlib import import_module +from pathlib import Path +from types import ModuleType +from typing import TYPE_CHECKING, Final + +from sphinx.errors import ExtensionError +from sphinx.ext.autosummary.generate import generate_autosummary_docs +from sphinx.util import logging + +if TYPE_CHECKING: + from collections.abc import Iterable, Sequence + + from sphinx.application import Sphinx + + +LOGGER = logging.getLogger(__name__) + +API_MODULES: Final = ("telegram", "telegram.ext", "telegram.request") +GENERATED_MARKER: Final = ( + ".. This file is generated by docs.auxil.api_docs. Do not edit it directly." +) +MANUAL_MARKER: Final = ( + ".. This API page is maintained manually and is not generated by docs.auxil.api_docs." +) + +# Most API objects belong in the package's default, alphabetically sorted toctree. Objects listed +# in these hand-written topic trees are subtracted from that default tree to avoid duplicate +# navigation entries. +TOP_LEVEL_SPECIALIZED_TREES: Final = ( + "telegram.inline-tree", + "telegram.payments-tree", + "telegram.games-tree", + "telegram.passport-tree", + "telegram.stickers-tree", +) +EXT_SPECIALIZED_TREES: Final = ( + "telegram.ext.handlers-tree", + "telegram.ext.persistence-tree", + "telegram.ext.acd-tree", + "telegram.ext.rate-limiting-tree", +) + +# These markers keep the small package-level RST files readable. During ``source-read`` they are +# replaced in memory with toctrees built from the current public exports. +TOCTREE_MARKERS: Final = { + "telegram.at-tree": ".. ptb-api-toctree:: available-types", + "telegram.ext": ".. ptb-api-toctree:: ext", + "telegram.request": ".. ptb-api-toctree:: request", +} + +# The old per-object RST files were almost all identical. Only genuine rendering differences live +# here; everything else receives the default options from the autosummary template. +DEFAULT_AUTODOC_OPTION_BLOCK: Final = " :members:\n :show-inheritance:" +AUTODOC_OPTION_BLOCKS: Final = { + "telegram.Chat": ( + " :members:\n :show-inheritance:\n :inherited-members: TelegramObject, object" + ), + "telegram.ChatFullInfo": ( + " :members:\n :show-inheritance:\n :inherited-members: TelegramObject, object" + ), + "telegram.ext.ApplicationBuilder": " :members:", + "telegram.ext.CallbackContext": " :members:", + "telegram.ext.ExtBot": ( + " :show-inheritance:\n" + " :members: insert_callback_data, defaults, rate_limiter, initialize, shutdown, " + "callback_data_cache" + ), + "telegram.ext.PersistenceInput": " :show-inheritance:", +} + + +def _api_object_names() -> tuple[str, ...]: + """Return the public API objects that should have their own documentation page. + + ``__all__`` is already PTB's source of truth for the supported public API. Reusing it here + means exporting a new class is enough to give it a reference page. + """ + names = [] + for module_name in API_MODULES: + module = import_module(module_name) + for name in module.__all__: + obj = getattr(module, name) + if not name.startswith("_") and not isinstance(obj, ModuleType): + names.append(f"{module_name}.{name}") + + return tuple(sorted(names, key=str.casefold)) + + +def _docname(object_name: str) -> str: + """Return the historic, lower-case Sphinx document name for an API object. + + ``autosummary_filename_map`` supports this explicit mapping: + https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html#confval-autosummary_filename_map + + Keeping the old names preserves URLs such as ``telegram.chatmember.html``. + """ + return object_name.lower() + + +def _generated_path(source_dir: Path, object_name: str) -> Path: + return source_dir / f"{_docname(object_name)}.rst" + + +def _has_marker(path: Path, marker: str) -> bool: + if not path.is_file(): + return False + + # Sphinx's default source encoding is ``utf-8-sig``, so autosummary output carries a BOM. + with path.open(encoding="utf-8-sig") as file: + return file.readline().rstrip() == marker + + +def _is_generated(path: Path) -> bool: + return _has_marker(path, GENERATED_MARKER) + + +def _is_manual(path: Path) -> bool: + """Return whether *path* is an explicit hand-written override of a generated API page.""" + return _has_marker(path, MANUAL_MARKER) + + +def _remove_generated_pages(source_dir: Path) -> None: + """Remove only API pages carrying our generator marker. + + The marker check protects package pages, topic trees, and manual object-page overrides. + """ + for path in source_dir.glob("telegram.*.rst"): + if _is_generated(path): + path.unlink() + + +def _autosummary_manifest(object_names: Sequence[str]) -> str: + objects = "\n".join(f" {name}" for name in object_names) + return ( + ".. autosummary::\n" + " :toctree:\n" + " :template: ptb-object.rst\n" + " :signatures: none\n" + f"\n{objects}\n" + ) + + +def _configure_autosummary(app: Sphinx, object_names: Sequence[str]) -> None: + filename_map = dict(app.config.autosummary_filename_map) + filename_map.update({name: _docname(name) for name in object_names}) + app.config.autosummary_filename_map = filename_map + + context = dict(app.config.autosummary_context) + context.update( + { + "ptb_autodoc_option_blocks": AUTODOC_OPTION_BLOCKS, + "ptb_default_autodoc_option_block": DEFAULT_AUTODOC_OPTION_BLOCK, + } + ) + app.config.autosummary_context = context + + +def _generate_api_pages(app: Sphinx) -> None: + """Create transient autosummary sources before Sphinx scans for documents. + + Autosummary still produces physical RST sources because Sphinx discovers documents by source + path. They are ignored by Git and deleted on both successful and failed builds, so they never + become files that maintainers need to review or update. + """ + source_dir = Path(app.srcdir) + # Clean up a previous build that was interrupted before ``build-finished`` could run. + _remove_generated_pages(source_dir) + + object_names = _api_object_names() + object_paths = {name: _generated_path(source_dir, name) for name in object_names} + manual_names = [name for name, path in object_paths.items() if _is_manual(path)] + generated_names = [name for name in object_names if name not in manual_names] + generated_paths = [object_paths[name] for name in generated_names] + + # A hand-written page must opt in with ``MANUAL_MARKER``. This prevents an untracked or stale + # file from silently taking precedence over the generated public API documentation. + conflicts = [path for path in object_paths.values() if path.exists() and not _is_manual(path)] + if conflicts: + formatted = "\n".join(f"* {path}" for path in conflicts) + raise ExtensionError( + "Refusing to overwrite API documentation pages without the manual-page marker:\n" + f"{formatted}" + ) + + _configure_autosummary(app, object_names) + + try: + with tempfile.TemporaryDirectory(prefix="ptb-api-docs-") as temp_dir: + manifest = Path(temp_dir) / "api.rst" + manifest.write_text(_autosummary_manifest(generated_names), encoding="utf-8") + generate_autosummary_docs( + [str(manifest)], + output_dir=source_dir, + app=app, + overwrite=True, + encoding=app.config.source_encoding, + ) + except Exception: + _remove_generated_pages(source_dir) + raise + + missing = [path for path in generated_paths if not _is_generated(path)] + if missing: + formatted = "\n".join(f"* {path}" for path in missing) + _remove_generated_pages(source_dir) + raise ExtensionError(f"Autosummary did not generate the expected API pages:\n{formatted}") + + LOGGER.info( + "generated %d transient API documentation pages; using %d manual overrides", + len(generated_paths), + len(manual_names), + ) + + +def _toctree_entries(path: Path) -> list[str]: + entries = [] + in_toctree = False + + for line in path.read_text(encoding="utf-8").splitlines(): + if line.startswith(".. toctree::"): + in_toctree = True + continue + if not in_toctree: + continue + if not line.strip() or line.startswith(" :"): + continue + if line.startswith(" "): + entries.append(line.strip().removesuffix(".rst")) + continue + in_toctree = False + + return entries + + +def _specialized_entries(source_dir: Path, tree_docnames: Iterable[str]) -> list[str]: + entries = [] + for docname in tree_docnames: + entries.extend(_toctree_entries(source_dir / f"{docname}.rst")) + + duplicates = sorted(name for name, count in Counter(entries).items() if count > 1) + if duplicates: + formatted = ", ".join(duplicates) + raise ExtensionError( + f"API objects occur in more than one specialized toctree: {formatted}" + ) + + return entries + + +def _render_toctree(entries: Iterable[str]) -> str: + body = "\n".join(f" {entry}" for entry in entries) + return f".. toctree::\n :titlesonly:\n\n{body}" + + +def _api_toctrees(source_dir: Path) -> dict[str, str]: + """Build the default package toctrees while preserving hand-curated topic groupings.""" + object_docnames = {_docname(name) for name in _api_object_names()} + + top_level = {name for name in object_docnames if name.count(".") == 1} + top_specialized = _specialized_entries(source_dir, TOP_LEVEL_SPECIALIZED_TREES) + unknown_top = set(top_specialized).difference(top_level) + if unknown_top: + formatted = ", ".join(sorted(unknown_top)) + raise ExtensionError(f"Unknown objects in specialized telegram toctrees: {formatted}") + + available_types = top_level.difference(top_specialized, {"telegram.bot"}) + + ext = {name for name in object_docnames if name.startswith("telegram.ext.")} + ext_specialized = _specialized_entries(source_dir, EXT_SPECIALIZED_TREES) + allowed_manual_ext_pages = {"telegram.ext.filters"} + unknown_ext = set(ext_specialized).difference(ext, allowed_manual_ext_pages) + if unknown_ext: + formatted = ", ".join(sorted(unknown_ext)) + raise ExtensionError(f"Unknown objects in specialized telegram.ext toctrees: {formatted}") + + ext_package = ext.difference(ext_specialized) + request = {name for name in object_docnames if name.startswith("telegram.request.")} + + return { + "telegram.at-tree": _render_toctree(sorted(available_types)), + "telegram.ext": _render_toctree([*sorted(ext_package), *EXT_SPECIALIZED_TREES]), + "telegram.request": _render_toctree(sorted(request)), + } + + +def _inject_api_toctree(app: Sphinx, docname: str, source: list[str]) -> None: + """Replace a package-page marker with its generated toctree in memory.""" + marker = TOCTREE_MARKERS.get(docname) + if marker is None: + return + if source[0].count(marker) != 1: + raise ExtensionError(f"{docname}.rst must contain exactly one {marker!r} marker") + + source[0] = source[0].replace(marker, _api_toctrees(Path(app.srcdir))[docname]) + + +def _cleanup_api_pages(app: Sphinx, exception: Exception | None) -> None: + """Remove transient sources even when Sphinx reports a build exception.""" + _remove_generated_pages(Path(app.srcdir)) + + +def setup(app: Sphinx) -> dict[str, object]: + app.connect("builder-inited", _generate_api_pages, priority=400) + app.connect("source-read", _inject_api_toctree) + app.connect("build-finished", _cleanup_api_pages) + return { + "version": "1.0", + "parallel_read_safe": True, + "parallel_write_safe": True, + } diff --git a/docs/source/_templates/ptb-object.rst b/docs/source/_templates/ptb-object.rst new file mode 100644 index 00000000000..fba97077716 --- /dev/null +++ b/docs/source/_templates/ptb-object.rst @@ -0,0 +1,8 @@ +.. This file is generated by docs.auxil.api_docs. Do not edit it directly. + +{{ objname | escape | underline }} + +.. currentmodule:: {{ module }} + +.. auto{{ objtype }}:: {{ objname }}{% if objtype in ["class", "exception"] %} +{{ ptb_autodoc_option_blocks.get(fullname, ptb_default_autodoc_option_block) }}{% endif %} diff --git a/docs/source/conf.py b/docs/source/conf.py index 309d718d9ac..addc1c3b766 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -43,6 +43,7 @@ extensions = [ "chango.sphinx_ext", "sphinx.ext.autodoc", + "sphinx.ext.autosummary", "sphinx.ext.napoleon", "sphinx.ext.intersphinx", "sphinx.ext.linkcode", @@ -51,6 +52,7 @@ "sphinx_copybutton", "sphinx_inline_tabs", "sphinxcontrib.mermaid", + "docs.auxil.api_docs", ] # Temporary. See #4387 diff --git a/docs/source/telegram.acceptedgifttypes.rst b/docs/source/telegram.acceptedgifttypes.rst deleted file mode 100644 index 2926dffd338..00000000000 --- a/docs/source/telegram.acceptedgifttypes.rst +++ /dev/null @@ -1,6 +0,0 @@ -AcceptedGiftTypes -================= - -.. autoclass:: telegram.AcceptedGiftTypes - :members: - :show-inheritance: diff --git a/docs/source/telegram.affiliateinfo.rst b/docs/source/telegram.affiliateinfo.rst deleted file mode 100644 index 0b2e51863af..00000000000 --- a/docs/source/telegram.affiliateinfo.rst +++ /dev/null @@ -1,6 +0,0 @@ -AffiliateInfo -============= - -.. autoclass:: telegram.AffiliateInfo - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.animation.rst b/docs/source/telegram.animation.rst deleted file mode 100644 index 4e654fad49c..00000000000 --- a/docs/source/telegram.animation.rst +++ /dev/null @@ -1,9 +0,0 @@ -Animation -========= - -.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject - -.. autoclass:: telegram.Animation - :members: - :show-inheritance: - :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.at-tree.rst b/docs/source/telegram.at-tree.rst index 4e638e33864..75f30e055ee 100644 --- a/docs/source/telegram.at-tree.rst +++ b/docs/source/telegram.at-tree.rst @@ -1,231 +1,4 @@ Available Types --------------- -.. toctree:: - :titlesonly: - - telegram.acceptedgifttypes - telegram.animation - telegram.audio - telegram.birthdate - telegram.botaccesssettings - telegram.botcommand - telegram.botcommandscope - telegram.botcommandscopeallchatadministrators - telegram.botcommandscopeallgroupchats - telegram.botcommandscopeallprivatechats - telegram.botcommandscopechat - telegram.botcommandscopechatadministrators - telegram.botcommandscopechatmember - telegram.botcommandscopedefault - telegram.botdescription - telegram.botname - telegram.botshortdescription - telegram.businessbotrights - telegram.businessconnection - telegram.businessintro - telegram.businesslocation - telegram.businessopeninghours - telegram.businessopeninghoursinterval - telegram.businessmessagesdeleted - telegram.callbackquery - telegram.chat - telegram.chatadministratorrights - telegram.chatbackground - telegram.checklist - telegram.checklisttask - telegram.checklisttasksadded - telegram.checklisttasksdone - telegram.copytextbutton - telegram.backgroundtype - telegram.backgroundtypefill - telegram.backgroundtypewallpaper - telegram.backgroundtypepattern - telegram.backgroundtypechattheme - telegram.backgroundfill - telegram.backgroundfillsolid - telegram.backgroundfillgradient - telegram.backgroundfillfreeformgradient - telegram.chatboost - telegram.chatboostadded - telegram.chatboostremoved - telegram.chatboostsource - telegram.chatboostsourcegiftcode - telegram.chatboostsourcegiveaway - telegram.chatboostsourcepremium - telegram.chatboostupdated - telegram.chatfullinfo - telegram.chatinvitelink - telegram.chatjoinrequest - telegram.chatlocation - telegram.chatmember - telegram.chatmemberadministrator - telegram.chatmemberbanned - telegram.chatmemberleft - telegram.chatmembermember - telegram.chatmemberowner - telegram.chatmemberrestricted - telegram.chatmemberupdated - telegram.chatownerchanged - telegram.chatownerleft - telegram.chatpermissions - telegram.chatphoto - telegram.chatshared - telegram.contact - telegram.dice - telegram.directmessagepricechanged - telegram.directmessagestopic - telegram.document - telegram.externalreplyinfo - telegram.file - telegram.forcereply - telegram.forumtopic - telegram.forumtopicclosed - telegram.forumtopiccreated - telegram.forumtopicedited - telegram.forumtopicreopened - telegram.generalforumtopichidden - telegram.generalforumtopicunhidden - telegram.giftbackground - telegram.giftinfo - telegram.giveaway - telegram.giveawaycompleted - telegram.giveawaycreated - telegram.giveawaywinners - telegram.inaccessiblemessage - telegram.inlinekeyboardbutton - telegram.inlinekeyboardmarkup - telegram.inputchecklist - telegram.inputchecklisttask - telegram.inputfile - telegram.inputmedia - telegram.inputmediaanimation - telegram.inputmediaaudio - telegram.inputmediadocument - telegram.inputmedialivephoto - telegram.inputmedialocation - telegram.inputmediaphoto - telegram.inputmediasticker - telegram.inputmediavenue - telegram.inputmediavideo - telegram.inputpaidmedia - telegram.inputpaidmedialivephoto - telegram.inputpaidmediaphoto - telegram.inputpaidmediavideo - telegram.inputpollmedia - telegram.inputprofilephoto - telegram.inputprofilephotoanimated - telegram.inputprofilephotostatic - telegram.inputpolloption - telegram.inputpolloptionmedia - telegram.inputstorycontent - telegram.inputstorycontentphoto - telegram.inputstorycontentvideo - telegram.keyboardbutton - telegram.keyboardbuttonpolltype - telegram.keyboardbuttonrequestchat - telegram.keyboardbuttonrequestmanagedbot - telegram.keyboardbuttonrequestusers - telegram.linkpreviewoptions - telegram.livephoto - telegram.location - telegram.locationaddress - telegram.loginurl - telegram.managedbotcreated - telegram.managedbotupdated - telegram.maybeinaccessiblemessage - telegram.menubutton - telegram.menubuttoncommands - telegram.menubuttondefault - telegram.menubuttonwebapp - telegram.message - telegram.messageautodeletetimerchanged - telegram.messageentity - telegram.messageid - telegram.messageorigin - telegram.messageoriginchannel - telegram.messageoriginchat - telegram.messageoriginhiddenuser - telegram.messageoriginuser - telegram.messagereactioncountupdated - telegram.messagereactionupdated - telegram.ownedgift - telegram.ownedgiftregular - telegram.ownedgifts - telegram.ownedgiftunique - telegram.paidmedia - telegram.paidmediainfo - telegram.paidmedialivephoto - telegram.paidmediaphoto - telegram.paidmediapreview - telegram.paidmediapurchased - telegram.paidmediavideo - telegram.paidmessagepricechanged - telegram.photosize - telegram.poll - telegram.pollanswer - telegram.pollmedia - telegram.polloption - telegram.polloptionadded - telegram.polloptiondeleted - telegram.preparedkeyboardbutton - telegram.proximityalerttriggered - telegram.reactioncount - telegram.reactiontype - telegram.reactiontypecustomemoji - telegram.reactiontypeemoji - telegram.reactiontypepaid - telegram.replykeyboardmarkup - telegram.replykeyboardremove - telegram.replyparameters - telegram.sentguestmessage - telegram.sentwebappmessage - telegram.shareduser - telegram.story - telegram.storyarea - telegram.storyareaposition - telegram.storyareatype - telegram.storyareatypelink - telegram.storyareatypelocation - telegram.storyareatypesuggestedreaction - telegram.storyareatypeuniquegift - telegram.storyareatypeweather - telegram.suggestedpostapprovalfailed - telegram.suggestedpostapproved - telegram.suggestedpostdeclined - telegram.suggestedpostinfo - telegram.suggestedpostpaid - telegram.suggestedpostparameters - telegram.suggestedpostprice - telegram.suggestedpostrefunded - telegram.switchinlinequerychosenchat - telegram.telegramobject - telegram.textquote - telegram.uniquegift - telegram.uniquegiftcolors - telegram.uniquegiftbackdrop - telegram.uniquegiftbackdropcolors - telegram.uniquegiftinfo - telegram.uniquegiftmodel - telegram.uniquegiftsymbol - telegram.update - telegram.user - telegram.userchatboosts - telegram.userprofileaudios - telegram.userprofilephotos - telegram.userrating - telegram.usersshared - telegram.venue - telegram.video - telegram.videochatended - telegram.videochatparticipantsinvited - telegram.videochatscheduled - telegram.videochatstarted - telegram.videonote - telegram.videoquality - telegram.voice - telegram.webappdata - telegram.webappinfo - telegram.webhookinfo - telegram.writeaccessallowed - +.. ptb-api-toctree:: available-types diff --git a/docs/source/telegram.audio.rst b/docs/source/telegram.audio.rst deleted file mode 100644 index 563de6c0289..00000000000 --- a/docs/source/telegram.audio.rst +++ /dev/null @@ -1,9 +0,0 @@ -Audio -===== - -.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject - -.. autoclass:: telegram.Audio - :members: - :show-inheritance: - :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.backgroundfill.rst b/docs/source/telegram.backgroundfill.rst deleted file mode 100644 index 0c7c03cb737..00000000000 --- a/docs/source/telegram.backgroundfill.rst +++ /dev/null @@ -1,8 +0,0 @@ -BackgroundFill -============== - -.. versionadded:: 21.2 - -.. autoclass:: telegram.BackgroundFill - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundfillfreeformgradient.rst b/docs/source/telegram.backgroundfillfreeformgradient.rst deleted file mode 100644 index 663c15e8181..00000000000 --- a/docs/source/telegram.backgroundfillfreeformgradient.rst +++ /dev/null @@ -1,8 +0,0 @@ -BackgroundFillFreeformGradient -============================== - -.. versionadded:: 21.2 - -.. autoclass:: telegram.BackgroundFillFreeformGradient - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundfillgradient.rst b/docs/source/telegram.backgroundfillgradient.rst deleted file mode 100644 index 313d4bd6468..00000000000 --- a/docs/source/telegram.backgroundfillgradient.rst +++ /dev/null @@ -1,8 +0,0 @@ -BackgroundFillGradient -====================== - -.. versionadded:: 21.2 - -.. autoclass:: telegram.BackgroundFillGradient - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundfillsolid.rst b/docs/source/telegram.backgroundfillsolid.rst deleted file mode 100644 index 5130de5f988..00000000000 --- a/docs/source/telegram.backgroundfillsolid.rst +++ /dev/null @@ -1,8 +0,0 @@ -BackgroundFillSolid -=================== - -.. versionadded:: 21.2 - -.. autoclass:: telegram.BackgroundFillSolid - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtype.rst b/docs/source/telegram.backgroundtype.rst deleted file mode 100644 index 08e9dc0222a..00000000000 --- a/docs/source/telegram.backgroundtype.rst +++ /dev/null @@ -1,8 +0,0 @@ -BackgroundType -============== - -.. versionadded:: 21.2 - -.. autoclass:: telegram.BackgroundType - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtypechattheme.rst b/docs/source/telegram.backgroundtypechattheme.rst deleted file mode 100644 index 1d26bde2076..00000000000 --- a/docs/source/telegram.backgroundtypechattheme.rst +++ /dev/null @@ -1,8 +0,0 @@ -BackgroundTypeChatTheme -======================= - -.. versionadded:: 21.2 - -.. autoclass:: telegram.BackgroundTypeChatTheme - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtypefill.rst b/docs/source/telegram.backgroundtypefill.rst deleted file mode 100644 index 636ff3d7ee2..00000000000 --- a/docs/source/telegram.backgroundtypefill.rst +++ /dev/null @@ -1,8 +0,0 @@ -BackgroundTypeFill -================== - -.. versionadded:: 21.2 - -.. autoclass:: telegram.BackgroundTypeFill - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtypepattern.rst b/docs/source/telegram.backgroundtypepattern.rst deleted file mode 100644 index 7b14d52bf46..00000000000 --- a/docs/source/telegram.backgroundtypepattern.rst +++ /dev/null @@ -1,8 +0,0 @@ -BackgroundTypePattern -===================== - -.. versionadded:: 21.2 - -.. autoclass:: telegram.BackgroundTypePattern - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtypewallpaper.rst b/docs/source/telegram.backgroundtypewallpaper.rst deleted file mode 100644 index 143c042553b..00000000000 --- a/docs/source/telegram.backgroundtypewallpaper.rst +++ /dev/null @@ -1,8 +0,0 @@ -BackgroundTypeWallpaper -======================= - -.. versionadded:: 21.2 - -.. autoclass:: telegram.BackgroundTypeWallpaper - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.birthdate.rst b/docs/source/telegram.birthdate.rst deleted file mode 100644 index 083de5ebf4a..00000000000 --- a/docs/source/telegram.birthdate.rst +++ /dev/null @@ -1,7 +0,0 @@ -Birthdate -========= - -.. autoclass:: telegram.Birthdate - :members: - :show-inheritance: - diff --git a/docs/source/telegram.bot.rst b/docs/source/telegram.bot.rst deleted file mode 100644 index 93211517ee4..00000000000 --- a/docs/source/telegram.bot.rst +++ /dev/null @@ -1,6 +0,0 @@ -Bot -=== - -.. autoclass:: telegram.Bot - :members: - :show-inheritance: diff --git a/docs/source/telegram.botaccesssettings.rst b/docs/source/telegram.botaccesssettings.rst deleted file mode 100644 index 788689b9266..00000000000 --- a/docs/source/telegram.botaccesssettings.rst +++ /dev/null @@ -1,6 +0,0 @@ -BotAccessSettings -================= - -.. autoclass:: telegram.BotAccessSettings - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommand.rst b/docs/source/telegram.botcommand.rst deleted file mode 100644 index a8e710f034f..00000000000 --- a/docs/source/telegram.botcommand.rst +++ /dev/null @@ -1,6 +0,0 @@ -BotCommand -========== - -.. autoclass:: telegram.BotCommand - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscope.rst b/docs/source/telegram.botcommandscope.rst deleted file mode 100644 index 9aae8723138..00000000000 --- a/docs/source/telegram.botcommandscope.rst +++ /dev/null @@ -1,6 +0,0 @@ -BotCommandScope -=============== - -.. autoclass:: telegram.BotCommandScope - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopeallchatadministrators.rst b/docs/source/telegram.botcommandscopeallchatadministrators.rst deleted file mode 100644 index f33c44a9dd1..00000000000 --- a/docs/source/telegram.botcommandscopeallchatadministrators.rst +++ /dev/null @@ -1,6 +0,0 @@ -BotCommandScopeAllChatAdministrators -==================================== - -.. autoclass:: telegram.BotCommandScopeAllChatAdministrators - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopeallgroupchats.rst b/docs/source/telegram.botcommandscopeallgroupchats.rst deleted file mode 100644 index 91833b20554..00000000000 --- a/docs/source/telegram.botcommandscopeallgroupchats.rst +++ /dev/null @@ -1,6 +0,0 @@ -BotCommandScopeAllGroupChats -============================ - -.. autoclass:: telegram.BotCommandScopeAllGroupChats - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopeallprivatechats.rst b/docs/source/telegram.botcommandscopeallprivatechats.rst deleted file mode 100644 index c0c5cef5c55..00000000000 --- a/docs/source/telegram.botcommandscopeallprivatechats.rst +++ /dev/null @@ -1,6 +0,0 @@ -BotCommandScopeAllPrivateChats -============================== - -.. autoclass:: telegram.BotCommandScopeAllPrivateChats - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopechat.rst b/docs/source/telegram.botcommandscopechat.rst deleted file mode 100644 index 9efac3f9d06..00000000000 --- a/docs/source/telegram.botcommandscopechat.rst +++ /dev/null @@ -1,6 +0,0 @@ -BotCommandScopeChat -=================== - -.. autoclass:: telegram.BotCommandScopeChat - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopechatadministrators.rst b/docs/source/telegram.botcommandscopechatadministrators.rst deleted file mode 100644 index e02b6ebdd30..00000000000 --- a/docs/source/telegram.botcommandscopechatadministrators.rst +++ /dev/null @@ -1,6 +0,0 @@ -BotCommandScopeChatAdministrators -================================= - -.. autoclass:: telegram.BotCommandScopeChatAdministrators - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopechatmember.rst b/docs/source/telegram.botcommandscopechatmember.rst deleted file mode 100644 index 65c7f63b0b6..00000000000 --- a/docs/source/telegram.botcommandscopechatmember.rst +++ /dev/null @@ -1,6 +0,0 @@ -BotCommandScopeChatMember -========================= - -.. autoclass:: telegram.BotCommandScopeChatMember - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopedefault.rst b/docs/source/telegram.botcommandscopedefault.rst deleted file mode 100644 index 89124ef0461..00000000000 --- a/docs/source/telegram.botcommandscopedefault.rst +++ /dev/null @@ -1,6 +0,0 @@ -BotCommandScopeDefault -====================== - -.. autoclass:: telegram.BotCommandScopeDefault - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botdescription.rst b/docs/source/telegram.botdescription.rst deleted file mode 100644 index 92903aa90ae..00000000000 --- a/docs/source/telegram.botdescription.rst +++ /dev/null @@ -1,6 +0,0 @@ -BotDescription -============== - -.. autoclass:: telegram.BotDescription - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botname.rst b/docs/source/telegram.botname.rst deleted file mode 100644 index 0f78027c7ba..00000000000 --- a/docs/source/telegram.botname.rst +++ /dev/null @@ -1,6 +0,0 @@ -BotName -======= - -.. autoclass:: telegram.BotName - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botshortdescription.rst b/docs/source/telegram.botshortdescription.rst deleted file mode 100644 index 76decd628de..00000000000 --- a/docs/source/telegram.botshortdescription.rst +++ /dev/null @@ -1,6 +0,0 @@ -BotShortDescription -=================== - -.. autoclass:: telegram.BotShortDescription - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessbotrights.rst b/docs/source/telegram.businessbotrights.rst deleted file mode 100644 index d6bdab1a809..00000000000 --- a/docs/source/telegram.businessbotrights.rst +++ /dev/null @@ -1,6 +0,0 @@ -BusinessBotRights -================= - -.. autoclass:: telegram.BusinessBotRights - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessconnection.rst b/docs/source/telegram.businessconnection.rst deleted file mode 100644 index 3ef31c3b25e..00000000000 --- a/docs/source/telegram.businessconnection.rst +++ /dev/null @@ -1,6 +0,0 @@ -BusinessConnection -================== - -.. autoclass:: telegram.BusinessConnection - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessintro.rst b/docs/source/telegram.businessintro.rst deleted file mode 100644 index 4870258e5b4..00000000000 --- a/docs/source/telegram.businessintro.rst +++ /dev/null @@ -1,6 +0,0 @@ -BusinessIntro -================== - -.. autoclass:: telegram.BusinessIntro - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businesslocation.rst b/docs/source/telegram.businesslocation.rst deleted file mode 100644 index 1a1b8893b65..00000000000 --- a/docs/source/telegram.businesslocation.rst +++ /dev/null @@ -1,6 +0,0 @@ -BusinessLocation -================== - -.. autoclass:: telegram.BusinessLocation - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessmessagesdeleted.rst b/docs/source/telegram.businessmessagesdeleted.rst deleted file mode 100644 index ba0e88e3cba..00000000000 --- a/docs/source/telegram.businessmessagesdeleted.rst +++ /dev/null @@ -1,6 +0,0 @@ -BusinessMessagesDeleted -======================= - -.. autoclass:: telegram.BusinessMessagesDeleted - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessopeninghours.rst b/docs/source/telegram.businessopeninghours.rst deleted file mode 100644 index cab989c8475..00000000000 --- a/docs/source/telegram.businessopeninghours.rst +++ /dev/null @@ -1,6 +0,0 @@ -BusinessOpeningHours -==================== - -.. autoclass:: telegram.BusinessOpeningHours - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessopeninghoursinterval.rst b/docs/source/telegram.businessopeninghoursinterval.rst deleted file mode 100644 index 241379dbcfb..00000000000 --- a/docs/source/telegram.businessopeninghoursinterval.rst +++ /dev/null @@ -1,6 +0,0 @@ -BusinessOpeningHoursInterval -============================ - -.. autoclass:: telegram.BusinessOpeningHoursInterval - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.callbackgame.rst b/docs/source/telegram.callbackgame.rst deleted file mode 100644 index c8b47a0a916..00000000000 --- a/docs/source/telegram.callbackgame.rst +++ /dev/null @@ -1,6 +0,0 @@ -Callbackgame -============ - -.. autoclass:: telegram.CallbackGame - :members: - :show-inheritance: diff --git a/docs/source/telegram.callbackquery.rst b/docs/source/telegram.callbackquery.rst deleted file mode 100644 index 02db37a8a91..00000000000 --- a/docs/source/telegram.callbackquery.rst +++ /dev/null @@ -1,6 +0,0 @@ -CallbackQuery -============= - -.. autoclass:: telegram.CallbackQuery - :members: - :show-inheritance: diff --git a/docs/source/telegram.chat.rst b/docs/source/telegram.chat.rst deleted file mode 100644 index df53940c4a7..00000000000 --- a/docs/source/telegram.chat.rst +++ /dev/null @@ -1,8 +0,0 @@ -Chat -==== - -.. Also lists methods of _ChatBase, but not the ones of TelegramObject -.. autoclass:: telegram.Chat - :members: - :show-inheritance: - :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.chatadministratorrights.rst b/docs/source/telegram.chatadministratorrights.rst deleted file mode 100644 index a9aee459bcd..00000000000 --- a/docs/source/telegram.chatadministratorrights.rst +++ /dev/null @@ -1,8 +0,0 @@ -ChatAdministratorRights -======================= - -.. versionadded:: 20.0 - -.. autoclass:: telegram.ChatAdministratorRights - :members: - :show-inheritance: diff --git a/docs/source/telegram.chatbackground.rst b/docs/source/telegram.chatbackground.rst deleted file mode 100644 index 6f43b27fb80..00000000000 --- a/docs/source/telegram.chatbackground.rst +++ /dev/null @@ -1,8 +0,0 @@ -ChatBackground -============== - -.. versionadded:: 21.2 - -.. autoclass:: telegram.ChatBackground - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboost.rst b/docs/source/telegram.chatboost.rst deleted file mode 100644 index 460240c6ce4..00000000000 --- a/docs/source/telegram.chatboost.rst +++ /dev/null @@ -1,8 +0,0 @@ -ChatBoost -========= - -.. versionadded:: 20.8 - -.. autoclass:: telegram.ChatBoost - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostadded.rst b/docs/source/telegram.chatboostadded.rst deleted file mode 100644 index b4551e75b84..00000000000 --- a/docs/source/telegram.chatboostadded.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatBoostAdded -============== - -.. autoclass:: telegram.ChatBoostAdded - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostremoved.rst b/docs/source/telegram.chatboostremoved.rst deleted file mode 100644 index ff7e1f37fd7..00000000000 --- a/docs/source/telegram.chatboostremoved.rst +++ /dev/null @@ -1,8 +0,0 @@ -ChatBoostRemoved -================ - -.. versionadded:: 20.8 - -.. autoclass:: telegram.ChatBoostRemoved - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostsource.rst b/docs/source/telegram.chatboostsource.rst deleted file mode 100644 index ab51f95c640..00000000000 --- a/docs/source/telegram.chatboostsource.rst +++ /dev/null @@ -1,8 +0,0 @@ -ChatBoostSource -=============== - -.. versionadded:: 20.8 - -.. autoclass:: telegram.ChatBoostSource - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostsourcegiftcode.rst b/docs/source/telegram.chatboostsourcegiftcode.rst deleted file mode 100644 index 8283d286a8c..00000000000 --- a/docs/source/telegram.chatboostsourcegiftcode.rst +++ /dev/null @@ -1,8 +0,0 @@ -ChatBoostSourceGiftCode -======================= - -.. versionadded:: 20.8 - -.. autoclass:: telegram.ChatBoostSourceGiftCode - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostsourcegiveaway.rst b/docs/source/telegram.chatboostsourcegiveaway.rst deleted file mode 100644 index a11a8a4ba45..00000000000 --- a/docs/source/telegram.chatboostsourcegiveaway.rst +++ /dev/null @@ -1,8 +0,0 @@ -ChatBoostSourceGiveaway -======================= - -.. versionadded:: 20.8 - -.. autoclass:: telegram.ChatBoostSourceGiveaway - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostsourcepremium.rst b/docs/source/telegram.chatboostsourcepremium.rst deleted file mode 100644 index 78f2c5dfd19..00000000000 --- a/docs/source/telegram.chatboostsourcepremium.rst +++ /dev/null @@ -1,8 +0,0 @@ -ChatBoostSourcePremium -====================== - -.. versionadded:: 20.8 - -.. autoclass:: telegram.ChatBoostSourcePremium - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostupdated.rst b/docs/source/telegram.chatboostupdated.rst deleted file mode 100644 index 9fc99a62d93..00000000000 --- a/docs/source/telegram.chatboostupdated.rst +++ /dev/null @@ -1,8 +0,0 @@ -ChatBoostUpdated -================ - -.. versionadded:: 20.8 - -.. autoclass:: telegram.ChatBoostUpdated - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatfullinfo.rst b/docs/source/telegram.chatfullinfo.rst deleted file mode 100644 index 7ba8f3d3828..00000000000 --- a/docs/source/telegram.chatfullinfo.rst +++ /dev/null @@ -1,8 +0,0 @@ -ChatFullInfo -============ - -.. Also lists methods of _ChatBase, but not the ones of TelegramObject -.. autoclass:: telegram.ChatFullInfo - :members: - :show-inheritance: - :inherited-members: TelegramObject, object \ No newline at end of file diff --git a/docs/source/telegram.chatinvitelink.rst b/docs/source/telegram.chatinvitelink.rst deleted file mode 100644 index 3314af1ec25..00000000000 --- a/docs/source/telegram.chatinvitelink.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatInviteLink -============== - -.. autoclass:: telegram.ChatInviteLink - :members: - :show-inheritance: diff --git a/docs/source/telegram.chatjoinrequest.rst b/docs/source/telegram.chatjoinrequest.rst deleted file mode 100644 index 8c4f5cb273d..00000000000 --- a/docs/source/telegram.chatjoinrequest.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatJoinRequest -=============== - -.. autoclass:: telegram.ChatJoinRequest - :members: - :show-inheritance: diff --git a/docs/source/telegram.chatlocation.rst b/docs/source/telegram.chatlocation.rst deleted file mode 100644 index 12b5e2127a1..00000000000 --- a/docs/source/telegram.chatlocation.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatLocation -============ - -.. autoclass:: telegram.ChatLocation - :members: - :show-inheritance: diff --git a/docs/source/telegram.chatmember.rst b/docs/source/telegram.chatmember.rst deleted file mode 100644 index 771b3636dee..00000000000 --- a/docs/source/telegram.chatmember.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatMember -========== - -.. autoclass:: telegram.ChatMember - :members: - :show-inheritance: diff --git a/docs/source/telegram.chatmemberadministrator.rst b/docs/source/telegram.chatmemberadministrator.rst deleted file mode 100644 index b9b385328f3..00000000000 --- a/docs/source/telegram.chatmemberadministrator.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatMemberAdministrator -======================= - -.. autoclass:: telegram.ChatMemberAdministrator - :members: - :show-inheritance: diff --git a/docs/source/telegram.chatmemberbanned.rst b/docs/source/telegram.chatmemberbanned.rst deleted file mode 100644 index f3d3fb7b6e2..00000000000 --- a/docs/source/telegram.chatmemberbanned.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatMemberBanned -================ - -.. autoclass:: telegram.ChatMemberBanned - :members: - :show-inheritance: diff --git a/docs/source/telegram.chatmemberleft.rst b/docs/source/telegram.chatmemberleft.rst deleted file mode 100644 index c692f73df52..00000000000 --- a/docs/source/telegram.chatmemberleft.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatMemberLeft -============== - -.. autoclass:: telegram.ChatMemberLeft - :members: - :show-inheritance: diff --git a/docs/source/telegram.chatmembermember.rst b/docs/source/telegram.chatmembermember.rst deleted file mode 100644 index 6a472380397..00000000000 --- a/docs/source/telegram.chatmembermember.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatMemberMember -================ - -.. autoclass:: telegram.ChatMemberMember - :members: - :show-inheritance: diff --git a/docs/source/telegram.chatmemberowner.rst b/docs/source/telegram.chatmemberowner.rst deleted file mode 100644 index 6f5217a3c9c..00000000000 --- a/docs/source/telegram.chatmemberowner.rst +++ /dev/null @@ -1,7 +0,0 @@ -ChatMemberOwner -=============== - -.. autoclass:: telegram.ChatMemberOwner - :members: - :show-inheritance: - diff --git a/docs/source/telegram.chatmemberrestricted.rst b/docs/source/telegram.chatmemberrestricted.rst deleted file mode 100644 index 97b5d3ec2c0..00000000000 --- a/docs/source/telegram.chatmemberrestricted.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatMemberRestricted -==================== - -.. autoclass:: telegram.ChatMemberRestricted - :members: - :show-inheritance: diff --git a/docs/source/telegram.chatmemberupdated.rst b/docs/source/telegram.chatmemberupdated.rst deleted file mode 100644 index 3c4dcf0a8cd..00000000000 --- a/docs/source/telegram.chatmemberupdated.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatMemberUpdated -================= - -.. autoclass:: telegram.ChatMemberUpdated - :members: - :show-inheritance: diff --git a/docs/source/telegram.chatownerchanged.rst b/docs/source/telegram.chatownerchanged.rst deleted file mode 100644 index fe8251fb349..00000000000 --- a/docs/source/telegram.chatownerchanged.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatOwnerChanged -================ - -.. autoclass:: telegram.ChatOwnerChanged - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatownerleft.rst b/docs/source/telegram.chatownerleft.rst deleted file mode 100644 index 62cb226d08f..00000000000 --- a/docs/source/telegram.chatownerleft.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatOwnerLeft -============= - -.. autoclass:: telegram.ChatOwnerLeft - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatpermissions.rst b/docs/source/telegram.chatpermissions.rst deleted file mode 100644 index d14479bb229..00000000000 --- a/docs/source/telegram.chatpermissions.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatPermissions -=============== - -.. autoclass:: telegram.ChatPermissions - :members: - :show-inheritance: diff --git a/docs/source/telegram.chatphoto.rst b/docs/source/telegram.chatphoto.rst deleted file mode 100644 index b5f337e9b5b..00000000000 --- a/docs/source/telegram.chatphoto.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatPhoto -========= - -.. autoclass:: telegram.ChatPhoto - :members: - :show-inheritance: diff --git a/docs/source/telegram.chatshared.rst b/docs/source/telegram.chatshared.rst deleted file mode 100644 index 5c654f7cb61..00000000000 --- a/docs/source/telegram.chatshared.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatShared -=================== - -.. autoclass:: telegram.ChatShared - :members: - :show-inheritance: diff --git a/docs/source/telegram.checklist.rst b/docs/source/telegram.checklist.rst deleted file mode 100644 index a01dac43aad..00000000000 --- a/docs/source/telegram.checklist.rst +++ /dev/null @@ -1,6 +0,0 @@ -Checklist -========= - -.. autoclass:: telegram.Checklist - :members: - :show-inheritance: diff --git a/docs/source/telegram.checklisttask.rst b/docs/source/telegram.checklisttask.rst deleted file mode 100644 index 27f44d629de..00000000000 --- a/docs/source/telegram.checklisttask.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChecklistTask -============= - -.. autoclass:: telegram.ChecklistTask - :members: - :show-inheritance: diff --git a/docs/source/telegram.checklisttasksadded.rst b/docs/source/telegram.checklisttasksadded.rst deleted file mode 100644 index d3c33c02300..00000000000 --- a/docs/source/telegram.checklisttasksadded.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChecklistTasksAdded -=================== - -.. autoclass:: telegram.ChecklistTasksAdded - :members: - :show-inheritance: diff --git a/docs/source/telegram.checklisttasksdone.rst b/docs/source/telegram.checklisttasksdone.rst deleted file mode 100644 index aa1e0b83f84..00000000000 --- a/docs/source/telegram.checklisttasksdone.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChecklistTasksDone -================== - -.. autoclass:: telegram.ChecklistTasksDone - :members: - :show-inheritance: diff --git a/docs/source/telegram.choseninlineresult.rst b/docs/source/telegram.choseninlineresult.rst deleted file mode 100644 index e357c1e07e9..00000000000 --- a/docs/source/telegram.choseninlineresult.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChosenInlineResult -================== - -.. autoclass:: telegram.ChosenInlineResult - :members: - :show-inheritance: diff --git a/docs/source/telegram.contact.rst b/docs/source/telegram.contact.rst deleted file mode 100644 index 682b4345884..00000000000 --- a/docs/source/telegram.contact.rst +++ /dev/null @@ -1,6 +0,0 @@ -Contact -======= - -.. autoclass:: telegram.Contact - :members: - :show-inheritance: diff --git a/docs/source/telegram.copytextbutton.rst b/docs/source/telegram.copytextbutton.rst deleted file mode 100644 index 7110fbf8b6b..00000000000 --- a/docs/source/telegram.copytextbutton.rst +++ /dev/null @@ -1,6 +0,0 @@ -CopyTextButton -============== - -.. autoclass:: telegram.CopyTextButton - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.credentials.rst b/docs/source/telegram.credentials.rst deleted file mode 100644 index 0b6cc68d207..00000000000 --- a/docs/source/telegram.credentials.rst +++ /dev/null @@ -1,6 +0,0 @@ -Credentials -=========== - -.. autoclass:: telegram.Credentials - :members: - :show-inheritance: diff --git a/docs/source/telegram.datacredentials.rst b/docs/source/telegram.datacredentials.rst deleted file mode 100644 index f6bc8643f03..00000000000 --- a/docs/source/telegram.datacredentials.rst +++ /dev/null @@ -1,6 +0,0 @@ -DataCredentials -=============== - -.. autoclass:: telegram.DataCredentials - :members: - :show-inheritance: diff --git a/docs/source/telegram.dice.rst b/docs/source/telegram.dice.rst deleted file mode 100644 index 827935d670d..00000000000 --- a/docs/source/telegram.dice.rst +++ /dev/null @@ -1,6 +0,0 @@ -Dice -==== - -.. autoclass:: telegram.Dice - :members: - :show-inheritance: diff --git a/docs/source/telegram.directmessagepricechanged.rst b/docs/source/telegram.directmessagepricechanged.rst deleted file mode 100644 index 64356e1a689..00000000000 --- a/docs/source/telegram.directmessagepricechanged.rst +++ /dev/null @@ -1,6 +0,0 @@ -DirectMessagePriceChanged -========================= - -.. autoclass:: telegram.DirectMessagePriceChanged - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.directmessagestopic.rst b/docs/source/telegram.directmessagestopic.rst deleted file mode 100644 index 9779a021c91..00000000000 --- a/docs/source/telegram.directmessagestopic.rst +++ /dev/null @@ -1,6 +0,0 @@ -DirectMessagesTopic -=================== - -.. autoclass:: telegram.DirectMessagesTopic - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.document.rst b/docs/source/telegram.document.rst deleted file mode 100644 index 1a337077069..00000000000 --- a/docs/source/telegram.document.rst +++ /dev/null @@ -1,8 +0,0 @@ -Document -======== -.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject - -.. autoclass:: telegram.Document - :members: - :show-inheritance: - :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.encryptedcredentials.rst b/docs/source/telegram.encryptedcredentials.rst deleted file mode 100644 index 7c7a61c83a3..00000000000 --- a/docs/source/telegram.encryptedcredentials.rst +++ /dev/null @@ -1,6 +0,0 @@ -EncryptedCredentials -==================== - -.. autoclass:: telegram.EncryptedCredentials - :members: - :show-inheritance: diff --git a/docs/source/telegram.encryptedpassportelement.rst b/docs/source/telegram.encryptedpassportelement.rst deleted file mode 100644 index 0204af1ee47..00000000000 --- a/docs/source/telegram.encryptedpassportelement.rst +++ /dev/null @@ -1,6 +0,0 @@ -EncryptedPassportElement -======================== - -.. autoclass:: telegram.EncryptedPassportElement - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.aioratelimiter.rst b/docs/source/telegram.ext.aioratelimiter.rst deleted file mode 100644 index de329f07770..00000000000 --- a/docs/source/telegram.ext.aioratelimiter.rst +++ /dev/null @@ -1,6 +0,0 @@ -AIORateLimiter -============== - -.. autoclass:: telegram.ext.AIORateLimiter - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.application.rst b/docs/source/telegram.ext.application.rst deleted file mode 100644 index 4b1a3f25991..00000000000 --- a/docs/source/telegram.ext.application.rst +++ /dev/null @@ -1,6 +0,0 @@ -Application -=========== - -.. autoclass:: telegram.ext.Application - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.applicationbuilder.rst b/docs/source/telegram.ext.applicationbuilder.rst deleted file mode 100644 index ec0a6574cdd..00000000000 --- a/docs/source/telegram.ext.applicationbuilder.rst +++ /dev/null @@ -1,5 +0,0 @@ -ApplicationBuilder -================== - -.. autoclass:: telegram.ext.ApplicationBuilder - :members: diff --git a/docs/source/telegram.ext.applicationhandlerstop.rst b/docs/source/telegram.ext.applicationhandlerstop.rst deleted file mode 100644 index db536aee178..00000000000 --- a/docs/source/telegram.ext.applicationhandlerstop.rst +++ /dev/null @@ -1,6 +0,0 @@ -ApplicationHandlerStop -====================== - -.. autoclass:: telegram.ext.ApplicationHandlerStop - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.basehandler.rst b/docs/source/telegram.ext.basehandler.rst deleted file mode 100644 index 9dfd607cee8..00000000000 --- a/docs/source/telegram.ext.basehandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -BaseHandler -=========== - -.. autoclass:: telegram.ext.BaseHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.basepersistence.rst b/docs/source/telegram.ext.basepersistence.rst deleted file mode 100644 index c45fcf65b4f..00000000000 --- a/docs/source/telegram.ext.basepersistence.rst +++ /dev/null @@ -1,6 +0,0 @@ -BasePersistence -=============== - -.. autoclass:: telegram.ext.BasePersistence - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.baseratelimiter.rst b/docs/source/telegram.ext.baseratelimiter.rst deleted file mode 100644 index 1d41db92b85..00000000000 --- a/docs/source/telegram.ext.baseratelimiter.rst +++ /dev/null @@ -1,6 +0,0 @@ -BaseRateLimiter -=============== - -.. autoclass:: telegram.ext.BaseRateLimiter - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.baseupdateprocessor.rst b/docs/source/telegram.ext.baseupdateprocessor.rst deleted file mode 100644 index 7155adf7191..00000000000 --- a/docs/source/telegram.ext.baseupdateprocessor.rst +++ /dev/null @@ -1,6 +0,0 @@ -BaseUpdateProcessor -=================== - -.. autoclass:: telegram.ext.BaseUpdateProcessor - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.businessconnectionhandler.rst b/docs/source/telegram.ext.businessconnectionhandler.rst deleted file mode 100644 index 0b0509dff2f..00000000000 --- a/docs/source/telegram.ext.businessconnectionhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -BusinessConnectionHandler -========================= - -.. autoclass:: telegram.ext.BusinessConnectionHandler - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.businessmessagesdeletedhandler.rst b/docs/source/telegram.ext.businessmessagesdeletedhandler.rst deleted file mode 100644 index 840f19325a0..00000000000 --- a/docs/source/telegram.ext.businessmessagesdeletedhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -BusinessMessagesDeletedHandler -============================== - -.. autoclass:: telegram.ext.BusinessMessagesDeletedHandler - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.callbackcontext.rst b/docs/source/telegram.ext.callbackcontext.rst deleted file mode 100644 index f88241d0dda..00000000000 --- a/docs/source/telegram.ext.callbackcontext.rst +++ /dev/null @@ -1,5 +0,0 @@ -CallbackContext -=============== - -.. autoclass:: telegram.ext.CallbackContext - :members: diff --git a/docs/source/telegram.ext.callbackdatacache.rst b/docs/source/telegram.ext.callbackdatacache.rst deleted file mode 100644 index 0ad16d09659..00000000000 --- a/docs/source/telegram.ext.callbackdatacache.rst +++ /dev/null @@ -1,6 +0,0 @@ -CallbackDataCache -================= - -.. autoclass:: telegram.ext.CallbackDataCache - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.callbackqueryhandler.rst b/docs/source/telegram.ext.callbackqueryhandler.rst deleted file mode 100644 index 1414993bb4f..00000000000 --- a/docs/source/telegram.ext.callbackqueryhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -CallbackQueryHandler -==================== - -.. autoclass:: telegram.ext.CallbackQueryHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.chatboosthandler.rst b/docs/source/telegram.ext.chatboosthandler.rst deleted file mode 100644 index 992972600d4..00000000000 --- a/docs/source/telegram.ext.chatboosthandler.rst +++ /dev/null @@ -1,8 +0,0 @@ -ChatBoostHandler -================ - -.. versionadded:: 20.8 - -.. autoclass:: telegram.ext.ChatBoostHandler - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.chatjoinrequesthandler.rst b/docs/source/telegram.ext.chatjoinrequesthandler.rst deleted file mode 100644 index 7f860a8fc81..00000000000 --- a/docs/source/telegram.ext.chatjoinrequesthandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatJoinRequestHandler -====================== - -.. autoclass:: telegram.ext.ChatJoinRequestHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.chatmemberhandler.rst b/docs/source/telegram.ext.chatmemberhandler.rst deleted file mode 100644 index e2662c30804..00000000000 --- a/docs/source/telegram.ext.chatmemberhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChatMemberHandler -================= - -.. autoclass:: telegram.ext.ChatMemberHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.choseninlineresulthandler.rst b/docs/source/telegram.ext.choseninlineresulthandler.rst deleted file mode 100644 index 19a0d975c29..00000000000 --- a/docs/source/telegram.ext.choseninlineresulthandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -ChosenInlineResultHandler -========================= - -.. autoclass:: telegram.ext.ChosenInlineResultHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.commandhandler.rst b/docs/source/telegram.ext.commandhandler.rst deleted file mode 100644 index 91d7be06596..00000000000 --- a/docs/source/telegram.ext.commandhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -CommandHandler -============== - -.. autoclass:: telegram.ext.CommandHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.contexttypes.rst b/docs/source/telegram.ext.contexttypes.rst deleted file mode 100644 index ef15bf7131b..00000000000 --- a/docs/source/telegram.ext.contexttypes.rst +++ /dev/null @@ -1,6 +0,0 @@ -ContextTypes -============ - -.. autoclass:: telegram.ext.ContextTypes - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.conversationhandler.rst b/docs/source/telegram.ext.conversationhandler.rst deleted file mode 100644 index 3ec96f1fdd6..00000000000 --- a/docs/source/telegram.ext.conversationhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -ConversationHandler -=================== - -.. autoclass:: telegram.ext.ConversationHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.defaults.rst b/docs/source/telegram.ext.defaults.rst deleted file mode 100644 index 365494614f9..00000000000 --- a/docs/source/telegram.ext.defaults.rst +++ /dev/null @@ -1,6 +0,0 @@ -Defaults -======== - -.. autoclass:: telegram.ext.Defaults - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.dictpersistence.rst b/docs/source/telegram.ext.dictpersistence.rst deleted file mode 100644 index d9f3ab56ae2..00000000000 --- a/docs/source/telegram.ext.dictpersistence.rst +++ /dev/null @@ -1,6 +0,0 @@ -DictPersistence -=============== - -.. autoclass:: telegram.ext.DictPersistence - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.extbot.rst b/docs/source/telegram.ext.extbot.rst deleted file mode 100644 index d61a36b0789..00000000000 --- a/docs/source/telegram.ext.extbot.rst +++ /dev/null @@ -1,6 +0,0 @@ -ExtBot -====== - -.. autoclass:: telegram.ext.ExtBot - :show-inheritance: - :members: insert_callback_data, defaults, rate_limiter, initialize, shutdown, callback_data_cache diff --git a/docs/source/telegram.ext.inlinequeryhandler.rst b/docs/source/telegram.ext.inlinequeryhandler.rst deleted file mode 100644 index 26469d99798..00000000000 --- a/docs/source/telegram.ext.inlinequeryhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryHandler -================== - -.. autoclass:: telegram.ext.InlineQueryHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.invalidcallbackdata.rst b/docs/source/telegram.ext.invalidcallbackdata.rst deleted file mode 100644 index 7bfc7e451ee..00000000000 --- a/docs/source/telegram.ext.invalidcallbackdata.rst +++ /dev/null @@ -1,6 +0,0 @@ -InvalidCallbackData -=================== - -.. autoclass:: telegram.ext.InvalidCallbackData - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.job.rst b/docs/source/telegram.ext.job.rst deleted file mode 100644 index 0f69756b371..00000000000 --- a/docs/source/telegram.ext.job.rst +++ /dev/null @@ -1,6 +0,0 @@ -Job -=== - -.. autoclass:: telegram.ext.Job - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.jobqueue.rst b/docs/source/telegram.ext.jobqueue.rst deleted file mode 100644 index 75658e30d3f..00000000000 --- a/docs/source/telegram.ext.jobqueue.rst +++ /dev/null @@ -1,6 +0,0 @@ -JobQueue -======== - -.. autoclass:: telegram.ext.JobQueue - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.managedbotupdatedhandler.rst b/docs/source/telegram.ext.managedbotupdatedhandler.rst deleted file mode 100644 index c59d8080389..00000000000 --- a/docs/source/telegram.ext.managedbotupdatedhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -ManagedBotUpdatedHandler -======================== - -.. autoclass:: telegram.ext.ManagedBotUpdatedHandler - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.messagehandler.rst b/docs/source/telegram.ext.messagehandler.rst deleted file mode 100644 index 2292eb44573..00000000000 --- a/docs/source/telegram.ext.messagehandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -MessageHandler -============== - -.. autoclass:: telegram.ext.MessageHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.messagereactionhandler.rst b/docs/source/telegram.ext.messagereactionhandler.rst deleted file mode 100644 index 1aad333ff1c..00000000000 --- a/docs/source/telegram.ext.messagereactionhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -MessageReactionHandler -====================== - -.. autoclass:: telegram.ext.MessageReactionHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.paidmediapurchasedhandler.rst b/docs/source/telegram.ext.paidmediapurchasedhandler.rst deleted file mode 100644 index 19bfbeea31e..00000000000 --- a/docs/source/telegram.ext.paidmediapurchasedhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -PaidMediaPurchasedHandler -========================= - -.. autoclass:: telegram.ext.PaidMediaPurchasedHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.persistenceinput.rst b/docs/source/telegram.ext.persistenceinput.rst deleted file mode 100644 index 4a1bc282295..00000000000 --- a/docs/source/telegram.ext.persistenceinput.rst +++ /dev/null @@ -1,5 +0,0 @@ -PersistenceInput -================ - -.. autoclass:: telegram.ext.PersistenceInput - :show-inheritance: diff --git a/docs/source/telegram.ext.picklepersistence.rst b/docs/source/telegram.ext.picklepersistence.rst deleted file mode 100644 index ffd65a20302..00000000000 --- a/docs/source/telegram.ext.picklepersistence.rst +++ /dev/null @@ -1,6 +0,0 @@ -PicklePersistence -================= - -.. autoclass:: telegram.ext.PicklePersistence - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.pollanswerhandler.rst b/docs/source/telegram.ext.pollanswerhandler.rst deleted file mode 100644 index 3f215e52029..00000000000 --- a/docs/source/telegram.ext.pollanswerhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -PollAnswerHandler -================= - -.. autoclass:: telegram.ext.PollAnswerHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.pollhandler.rst b/docs/source/telegram.ext.pollhandler.rst deleted file mode 100644 index 2f6c19f26a0..00000000000 --- a/docs/source/telegram.ext.pollhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -PollHandler -=========== - -.. autoclass:: telegram.ext.PollHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.precheckoutqueryhandler.rst b/docs/source/telegram.ext.precheckoutqueryhandler.rst deleted file mode 100644 index 482cba07b34..00000000000 --- a/docs/source/telegram.ext.precheckoutqueryhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -PreCheckoutQueryHandler -======================= - -.. autoclass:: telegram.ext.PreCheckoutQueryHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.prefixhandler.rst b/docs/source/telegram.ext.prefixhandler.rst deleted file mode 100644 index ad76838520a..00000000000 --- a/docs/source/telegram.ext.prefixhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -PrefixHandler -============= - -.. autoclass:: telegram.ext.PrefixHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.rst b/docs/source/telegram.ext.rst index ab9efc1b353..37642a4e18c 100644 --- a/docs/source/telegram.ext.rst +++ b/docs/source/telegram.ext.rst @@ -3,22 +3,4 @@ telegram.ext package .. automodule:: telegram.ext -.. toctree:: - :titlesonly: - - telegram.ext.application - telegram.ext.applicationbuilder - telegram.ext.applicationhandlerstop - telegram.ext.baseupdateprocessor - telegram.ext.callbackcontext - telegram.ext.contexttypes - telegram.ext.defaults - telegram.ext.extbot - telegram.ext.job - telegram.ext.jobqueue - telegram.ext.simpleupdateprocessor - telegram.ext.updater - telegram.ext.handlers-tree.rst - telegram.ext.persistence-tree.rst - telegram.ext.acd-tree.rst - telegram.ext.rate-limiting-tree.rst \ No newline at end of file +.. ptb-api-toctree:: ext diff --git a/docs/source/telegram.ext.shippingqueryhandler.rst b/docs/source/telegram.ext.shippingqueryhandler.rst deleted file mode 100644 index f368630fd38..00000000000 --- a/docs/source/telegram.ext.shippingqueryhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -ShippingQueryHandler -==================== - -.. autoclass:: telegram.ext.ShippingQueryHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.simpleupdateprocessor.rst b/docs/source/telegram.ext.simpleupdateprocessor.rst deleted file mode 100644 index 1e30c27566c..00000000000 --- a/docs/source/telegram.ext.simpleupdateprocessor.rst +++ /dev/null @@ -1,6 +0,0 @@ -SimpleUpdateProcessor -===================== - -.. autoclass:: telegram.ext.SimpleUpdateProcessor - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.stringcommandhandler.rst b/docs/source/telegram.ext.stringcommandhandler.rst deleted file mode 100644 index c716753ef11..00000000000 --- a/docs/source/telegram.ext.stringcommandhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -StringCommandHandler -==================== - -.. autoclass:: telegram.ext.StringCommandHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.stringregexhandler.rst b/docs/source/telegram.ext.stringregexhandler.rst deleted file mode 100644 index d8d8ef025f6..00000000000 --- a/docs/source/telegram.ext.stringregexhandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -StringRegexHandler -================== - -.. autoclass:: telegram.ext.StringRegexHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.typehandler.rst b/docs/source/telegram.ext.typehandler.rst deleted file mode 100644 index a85dd0f191c..00000000000 --- a/docs/source/telegram.ext.typehandler.rst +++ /dev/null @@ -1,6 +0,0 @@ -TypeHandler -=========== - -.. autoclass:: telegram.ext.TypeHandler - :members: - :show-inheritance: diff --git a/docs/source/telegram.ext.updater.rst b/docs/source/telegram.ext.updater.rst deleted file mode 100644 index 642ddd20209..00000000000 --- a/docs/source/telegram.ext.updater.rst +++ /dev/null @@ -1,6 +0,0 @@ -Updater -======= - -.. autoclass:: telegram.ext.Updater - :members: - :show-inheritance: diff --git a/docs/source/telegram.externalreplyinfo.rst b/docs/source/telegram.externalreplyinfo.rst deleted file mode 100644 index 568bf07ef38..00000000000 --- a/docs/source/telegram.externalreplyinfo.rst +++ /dev/null @@ -1,6 +0,0 @@ -ExternalReplyInfo -================= - -.. autoclass:: telegram.ExternalReplyInfo - :members: - :show-inheritance: diff --git a/docs/source/telegram.file.rst b/docs/source/telegram.file.rst deleted file mode 100644 index 479474678dc..00000000000 --- a/docs/source/telegram.file.rst +++ /dev/null @@ -1,6 +0,0 @@ -File -==== - -.. autoclass:: telegram.File - :members: - :show-inheritance: diff --git a/docs/source/telegram.filecredentials.rst b/docs/source/telegram.filecredentials.rst deleted file mode 100644 index b82338ce7e6..00000000000 --- a/docs/source/telegram.filecredentials.rst +++ /dev/null @@ -1,6 +0,0 @@ -FileCredentials -=============== - -.. autoclass:: telegram.FileCredentials - :members: - :show-inheritance: diff --git a/docs/source/telegram.forcereply.rst b/docs/source/telegram.forcereply.rst deleted file mode 100644 index 8418d56f1aa..00000000000 --- a/docs/source/telegram.forcereply.rst +++ /dev/null @@ -1,6 +0,0 @@ -ForceReply -========== - -.. autoclass:: telegram.ForceReply - :members: - :show-inheritance: diff --git a/docs/source/telegram.forumtopic.rst b/docs/source/telegram.forumtopic.rst deleted file mode 100644 index ba2ceb3a4df..00000000000 --- a/docs/source/telegram.forumtopic.rst +++ /dev/null @@ -1,6 +0,0 @@ -ForumTopic -========== - -.. autoclass:: telegram.ForumTopic - :members: - :show-inheritance: diff --git a/docs/source/telegram.forumtopicclosed.rst b/docs/source/telegram.forumtopicclosed.rst deleted file mode 100644 index 1954cc4e078..00000000000 --- a/docs/source/telegram.forumtopicclosed.rst +++ /dev/null @@ -1,6 +0,0 @@ -ForumTopicClosed -================ - -.. autoclass:: telegram.ForumTopicClosed - :members: - :show-inheritance: diff --git a/docs/source/telegram.forumtopiccreated.rst b/docs/source/telegram.forumtopiccreated.rst deleted file mode 100644 index 828aacee88f..00000000000 --- a/docs/source/telegram.forumtopiccreated.rst +++ /dev/null @@ -1,6 +0,0 @@ -ForumTopicCreated -================= - -.. autoclass:: telegram.ForumTopicCreated - :members: - :show-inheritance: diff --git a/docs/source/telegram.forumtopicedited.rst b/docs/source/telegram.forumtopicedited.rst deleted file mode 100644 index 1b0a09a4868..00000000000 --- a/docs/source/telegram.forumtopicedited.rst +++ /dev/null @@ -1,6 +0,0 @@ -ForumTopicEdited -================ - -.. autoclass:: telegram.ForumTopicEdited - :members: - :show-inheritance: diff --git a/docs/source/telegram.forumtopicreopened.rst b/docs/source/telegram.forumtopicreopened.rst deleted file mode 100644 index d1e021865ba..00000000000 --- a/docs/source/telegram.forumtopicreopened.rst +++ /dev/null @@ -1,6 +0,0 @@ -ForumTopicReopened -================== - -.. autoclass:: telegram.ForumTopicReopened - :members: - :show-inheritance: diff --git a/docs/source/telegram.game.rst b/docs/source/telegram.game.rst deleted file mode 100644 index 53f55489f2f..00000000000 --- a/docs/source/telegram.game.rst +++ /dev/null @@ -1,6 +0,0 @@ -Game -==== - -.. autoclass:: telegram.Game - :members: - :show-inheritance: diff --git a/docs/source/telegram.gamehighscore.rst b/docs/source/telegram.gamehighscore.rst deleted file mode 100644 index 784e4dd3a8c..00000000000 --- a/docs/source/telegram.gamehighscore.rst +++ /dev/null @@ -1,6 +0,0 @@ -GameHighScore -============= - -.. autoclass:: telegram.GameHighScore - :members: - :show-inheritance: diff --git a/docs/source/telegram.generalforumtopichidden.rst b/docs/source/telegram.generalforumtopichidden.rst deleted file mode 100644 index 5d70e782f1a..00000000000 --- a/docs/source/telegram.generalforumtopichidden.rst +++ /dev/null @@ -1,6 +0,0 @@ -GeneralForumTopicHidden -======================= - -.. autoclass:: telegram.GeneralForumTopicHidden - :members: - :show-inheritance: diff --git a/docs/source/telegram.generalforumtopicunhidden.rst b/docs/source/telegram.generalforumtopicunhidden.rst deleted file mode 100644 index ee82c770b99..00000000000 --- a/docs/source/telegram.generalforumtopicunhidden.rst +++ /dev/null @@ -1,6 +0,0 @@ -GeneralForumTopicUnhidden -========================= - -.. autoclass:: telegram.GeneralForumTopicUnhidden - :members: - :show-inheritance: diff --git a/docs/source/telegram.gift.rst b/docs/source/telegram.gift.rst deleted file mode 100644 index e42cb720ac2..00000000000 --- a/docs/source/telegram.gift.rst +++ /dev/null @@ -1,6 +0,0 @@ -Gift -==== - -.. autoclass:: telegram.Gift - :members: - :show-inheritance: diff --git a/docs/source/telegram.giftbackground.rst b/docs/source/telegram.giftbackground.rst deleted file mode 100644 index c2785ff67b0..00000000000 --- a/docs/source/telegram.giftbackground.rst +++ /dev/null @@ -1,7 +0,0 @@ -GiftBackground -============== - -.. autoclass:: telegram.GiftBackground - :members: - :show-inheritance: - diff --git a/docs/source/telegram.giftinfo.rst b/docs/source/telegram.giftinfo.rst deleted file mode 100644 index ff5ab6ad352..00000000000 --- a/docs/source/telegram.giftinfo.rst +++ /dev/null @@ -1,7 +0,0 @@ -GiftInfo -======== - -.. autoclass:: telegram.GiftInfo - :members: - :show-inheritance: - diff --git a/docs/source/telegram.gifts.rst b/docs/source/telegram.gifts.rst deleted file mode 100644 index 649522d0dce..00000000000 --- a/docs/source/telegram.gifts.rst +++ /dev/null @@ -1,6 +0,0 @@ -Gifts -===== - -.. autoclass:: telegram.Gifts - :members: - :show-inheritance: diff --git a/docs/source/telegram.giveaway.rst b/docs/source/telegram.giveaway.rst deleted file mode 100644 index 8d1d854985a..00000000000 --- a/docs/source/telegram.giveaway.rst +++ /dev/null @@ -1,6 +0,0 @@ -Giveaway -======== - -.. autoclass:: telegram.Giveaway - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giveawaycompleted.rst b/docs/source/telegram.giveawaycompleted.rst deleted file mode 100644 index c89e9564e85..00000000000 --- a/docs/source/telegram.giveawaycompleted.rst +++ /dev/null @@ -1,6 +0,0 @@ -GiveawayCompleted -================= - -.. autoclass:: telegram.GiveawayCompleted - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giveawaycreated.rst b/docs/source/telegram.giveawaycreated.rst deleted file mode 100644 index f29de887751..00000000000 --- a/docs/source/telegram.giveawaycreated.rst +++ /dev/null @@ -1,6 +0,0 @@ -GiveawayCreated -=============== - -.. autoclass:: telegram.GiveawayCreated - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giveawaywinners.rst b/docs/source/telegram.giveawaywinners.rst deleted file mode 100644 index 4be51e8502b..00000000000 --- a/docs/source/telegram.giveawaywinners.rst +++ /dev/null @@ -1,6 +0,0 @@ -GiveawayWinners -=============== - -.. autoclass:: telegram.GiveawayWinners - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.iddocumentdata.rst b/docs/source/telegram.iddocumentdata.rst deleted file mode 100644 index 999d23bcc87..00000000000 --- a/docs/source/telegram.iddocumentdata.rst +++ /dev/null @@ -1,6 +0,0 @@ -IdDocumentData -============== - -.. autoclass:: telegram.IdDocumentData - :members: - :show-inheritance: diff --git a/docs/source/telegram.inaccessiblemessage.rst b/docs/source/telegram.inaccessiblemessage.rst deleted file mode 100644 index d65c8c42c71..00000000000 --- a/docs/source/telegram.inaccessiblemessage.rst +++ /dev/null @@ -1,6 +0,0 @@ -InaccessibleMessage -=================== - -.. autoclass:: telegram.InaccessibleMessage - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinekeyboardbutton.rst b/docs/source/telegram.inlinekeyboardbutton.rst deleted file mode 100644 index ff61d6fb400..00000000000 --- a/docs/source/telegram.inlinekeyboardbutton.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineKeyboardButton -==================== - -.. autoclass:: telegram.InlineKeyboardButton - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinekeyboardmarkup.rst b/docs/source/telegram.inlinekeyboardmarkup.rst deleted file mode 100644 index 99a44cc9e39..00000000000 --- a/docs/source/telegram.inlinekeyboardmarkup.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineKeyboardMarkup -==================== - -.. autoclass:: telegram.InlineKeyboardMarkup - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequery.rst b/docs/source/telegram.inlinequery.rst deleted file mode 100644 index eb806aa3876..00000000000 --- a/docs/source/telegram.inlinequery.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQuery -=========== - -.. autoclass:: telegram.InlineQuery - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresult.rst b/docs/source/telegram.inlinequeryresult.rst deleted file mode 100644 index eda58f1c245..00000000000 --- a/docs/source/telegram.inlinequeryresult.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResult -================= - -.. autoclass:: telegram.InlineQueryResult - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultarticle.rst b/docs/source/telegram.inlinequeryresultarticle.rst deleted file mode 100644 index 1600c05903f..00000000000 --- a/docs/source/telegram.inlinequeryresultarticle.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultArticle -======================== - -.. autoclass:: telegram.InlineQueryResultArticle - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultaudio.rst b/docs/source/telegram.inlinequeryresultaudio.rst deleted file mode 100644 index a78399b0025..00000000000 --- a/docs/source/telegram.inlinequeryresultaudio.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultAudio -====================== - -.. autoclass:: telegram.InlineQueryResultAudio - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultcachedaudio.rst b/docs/source/telegram.inlinequeryresultcachedaudio.rst deleted file mode 100644 index 860b7a4edb3..00000000000 --- a/docs/source/telegram.inlinequeryresultcachedaudio.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultCachedAudio -============================ - -.. autoclass:: telegram.InlineQueryResultCachedAudio - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultcacheddocument.rst b/docs/source/telegram.inlinequeryresultcacheddocument.rst deleted file mode 100644 index 6768b75210c..00000000000 --- a/docs/source/telegram.inlinequeryresultcacheddocument.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultCachedDocument -=============================== - -.. autoclass:: telegram.InlineQueryResultCachedDocument - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultcachedgif.rst b/docs/source/telegram.inlinequeryresultcachedgif.rst deleted file mode 100644 index c0b2f627779..00000000000 --- a/docs/source/telegram.inlinequeryresultcachedgif.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultCachedGif -========================== - -.. autoclass:: telegram.InlineQueryResultCachedGif - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst b/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst deleted file mode 100644 index 780fca432b4..00000000000 --- a/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultCachedMpeg4Gif -=============================== - -.. autoclass:: telegram.InlineQueryResultCachedMpeg4Gif - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultcachedphoto.rst b/docs/source/telegram.inlinequeryresultcachedphoto.rst deleted file mode 100644 index 8a5b1bc4bfb..00000000000 --- a/docs/source/telegram.inlinequeryresultcachedphoto.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultCachedPhoto -============================ - -.. autoclass:: telegram.InlineQueryResultCachedPhoto - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultcachedsticker.rst b/docs/source/telegram.inlinequeryresultcachedsticker.rst deleted file mode 100644 index eb204cb88df..00000000000 --- a/docs/source/telegram.inlinequeryresultcachedsticker.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultCachedSticker -============================== - -.. autoclass:: telegram.InlineQueryResultCachedSticker - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultcachedvideo.rst b/docs/source/telegram.inlinequeryresultcachedvideo.rst deleted file mode 100644 index 121d5b95b08..00000000000 --- a/docs/source/telegram.inlinequeryresultcachedvideo.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultCachedVideo -============================ - -.. autoclass:: telegram.InlineQueryResultCachedVideo - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultcachedvoice.rst b/docs/source/telegram.inlinequeryresultcachedvoice.rst deleted file mode 100644 index dbe132af190..00000000000 --- a/docs/source/telegram.inlinequeryresultcachedvoice.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultCachedVoice -============================ - -.. autoclass:: telegram.InlineQueryResultCachedVoice - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultcontact.rst b/docs/source/telegram.inlinequeryresultcontact.rst deleted file mode 100644 index 3fee7ac4e37..00000000000 --- a/docs/source/telegram.inlinequeryresultcontact.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultContact -======================== - -.. autoclass:: telegram.InlineQueryResultContact - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultdocument.rst b/docs/source/telegram.inlinequeryresultdocument.rst deleted file mode 100644 index 914fc0c0df2..00000000000 --- a/docs/source/telegram.inlinequeryresultdocument.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultDocument -========================= - -.. autoclass:: telegram.InlineQueryResultDocument - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultgame.rst b/docs/source/telegram.inlinequeryresultgame.rst deleted file mode 100644 index 8c3189c8179..00000000000 --- a/docs/source/telegram.inlinequeryresultgame.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultGame -===================== - -.. autoclass:: telegram.InlineQueryResultGame - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultgif.rst b/docs/source/telegram.inlinequeryresultgif.rst deleted file mode 100644 index c19a9f79024..00000000000 --- a/docs/source/telegram.inlinequeryresultgif.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultGif -==================== - -.. autoclass:: telegram.InlineQueryResultGif - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultlocation.rst b/docs/source/telegram.inlinequeryresultlocation.rst deleted file mode 100644 index 053bb74f00c..00000000000 --- a/docs/source/telegram.inlinequeryresultlocation.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultLocation -========================= - -.. autoclass:: telegram.InlineQueryResultLocation - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultmpeg4gif.rst b/docs/source/telegram.inlinequeryresultmpeg4gif.rst deleted file mode 100644 index 6e6d68bf725..00000000000 --- a/docs/source/telegram.inlinequeryresultmpeg4gif.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultMpeg4Gif -========================= - -.. autoclass:: telegram.InlineQueryResultMpeg4Gif - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultphoto.rst b/docs/source/telegram.inlinequeryresultphoto.rst deleted file mode 100644 index b7f4671cafc..00000000000 --- a/docs/source/telegram.inlinequeryresultphoto.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultPhoto -====================== - -.. autoclass:: telegram.InlineQueryResultPhoto - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultsbutton.rst b/docs/source/telegram.inlinequeryresultsbutton.rst deleted file mode 100644 index 7323a20cc60..00000000000 --- a/docs/source/telegram.inlinequeryresultsbutton.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultsButton -======================== - -.. autoclass:: telegram.InlineQueryResultsButton - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultvenue.rst b/docs/source/telegram.inlinequeryresultvenue.rst deleted file mode 100644 index 0c5f19b03ae..00000000000 --- a/docs/source/telegram.inlinequeryresultvenue.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultVenue -====================== - -.. autoclass:: telegram.InlineQueryResultVenue - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultvideo.rst b/docs/source/telegram.inlinequeryresultvideo.rst deleted file mode 100644 index 3df6d559ac1..00000000000 --- a/docs/source/telegram.inlinequeryresultvideo.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultVideo -====================== - -.. autoclass:: telegram.InlineQueryResultVideo - :members: - :show-inheritance: diff --git a/docs/source/telegram.inlinequeryresultvoice.rst b/docs/source/telegram.inlinequeryresultvoice.rst deleted file mode 100644 index 8194b3ad62a..00000000000 --- a/docs/source/telegram.inlinequeryresultvoice.rst +++ /dev/null @@ -1,6 +0,0 @@ -InlineQueryResultVoice -====================== - -.. autoclass:: telegram.InlineQueryResultVoice - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputchecklist.rst b/docs/source/telegram.inputchecklist.rst deleted file mode 100644 index f83345884a0..00000000000 --- a/docs/source/telegram.inputchecklist.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputChecklist -============== - -.. autoclass:: telegram.InputChecklist - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputchecklisttask.rst b/docs/source/telegram.inputchecklisttask.rst deleted file mode 100644 index 1cc14095b0c..00000000000 --- a/docs/source/telegram.inputchecklisttask.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputChecklistTask -================== - -.. autoclass:: telegram.InputChecklistTask - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputcontactmessagecontent.rst b/docs/source/telegram.inputcontactmessagecontent.rst deleted file mode 100644 index 5deb70724d4..00000000000 --- a/docs/source/telegram.inputcontactmessagecontent.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputContactMessageContent -========================== - -.. autoclass:: telegram.InputContactMessageContent - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputfile.rst b/docs/source/telegram.inputfile.rst deleted file mode 100644 index 717f9235a9f..00000000000 --- a/docs/source/telegram.inputfile.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputFile -========= - -.. autoclass:: telegram.InputFile - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputinvoicemessagecontent.rst b/docs/source/telegram.inputinvoicemessagecontent.rst deleted file mode 100644 index 0354229e76f..00000000000 --- a/docs/source/telegram.inputinvoicemessagecontent.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputInvoiceMessageContent -========================== - -.. autoclass:: telegram.InputInvoiceMessageContent - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputlocationmessagecontent.rst b/docs/source/telegram.inputlocationmessagecontent.rst deleted file mode 100644 index 51359967ce4..00000000000 --- a/docs/source/telegram.inputlocationmessagecontent.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputLocationMessageContent -=========================== - -.. autoclass:: telegram.InputLocationMessageContent - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputmedia.rst b/docs/source/telegram.inputmedia.rst deleted file mode 100644 index 4f58bbb0e5a..00000000000 --- a/docs/source/telegram.inputmedia.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputMedia -========== - -.. autoclass:: telegram.InputMedia - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputmediaanimation.rst b/docs/source/telegram.inputmediaanimation.rst deleted file mode 100644 index 4324182d7d0..00000000000 --- a/docs/source/telegram.inputmediaanimation.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputMediaAnimation -=================== - -.. autoclass:: telegram.InputMediaAnimation - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputmediaaudio.rst b/docs/source/telegram.inputmediaaudio.rst deleted file mode 100644 index f91484ed3c9..00000000000 --- a/docs/source/telegram.inputmediaaudio.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputMediaAudio -=============== - -.. autoclass:: telegram.InputMediaAudio - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputmediadocument.rst b/docs/source/telegram.inputmediadocument.rst deleted file mode 100644 index e6681a73b32..00000000000 --- a/docs/source/telegram.inputmediadocument.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputMediaDocument -================== - -.. autoclass:: telegram.InputMediaDocument - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputmedialivephoto.rst b/docs/source/telegram.inputmedialivephoto.rst deleted file mode 100644 index 975614554a1..00000000000 --- a/docs/source/telegram.inputmedialivephoto.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputMediaLivePhoto -=================== - -.. autoclass:: telegram.InputMediaLivePhoto - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmedialocation.rst b/docs/source/telegram.inputmedialocation.rst deleted file mode 100644 index aa20d631ea4..00000000000 --- a/docs/source/telegram.inputmedialocation.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputMediaLocation -================== - -.. autoclass:: telegram.InputMediaLocation - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputmediaphoto.rst b/docs/source/telegram.inputmediaphoto.rst deleted file mode 100644 index ad7091fe7e0..00000000000 --- a/docs/source/telegram.inputmediaphoto.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputMediaPhoto -=============== - -.. autoclass:: telegram.InputMediaPhoto - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputmediasticker.rst b/docs/source/telegram.inputmediasticker.rst deleted file mode 100644 index 7f2b6d7778e..00000000000 --- a/docs/source/telegram.inputmediasticker.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputMediaSticker -================= - -.. autoclass:: telegram.InputMediaSticker - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputmediavenue.rst b/docs/source/telegram.inputmediavenue.rst deleted file mode 100644 index e5e221e2f73..00000000000 --- a/docs/source/telegram.inputmediavenue.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputMediaVenue -=============== - -.. autoclass:: telegram.InputMediaVenue - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputmediavideo.rst b/docs/source/telegram.inputmediavideo.rst deleted file mode 100644 index 751261c4804..00000000000 --- a/docs/source/telegram.inputmediavideo.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputMediaVideo -=============== - -.. autoclass:: telegram.InputMediaVideo - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputmessagecontent.rst b/docs/source/telegram.inputmessagecontent.rst deleted file mode 100644 index a7b50b5b488..00000000000 --- a/docs/source/telegram.inputmessagecontent.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputMessageContent -=================== - -.. autoclass:: telegram.InputMessageContent - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputpaidmedia.rst b/docs/source/telegram.inputpaidmedia.rst deleted file mode 100644 index ecb45d35f6d..00000000000 --- a/docs/source/telegram.inputpaidmedia.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputPaidMedia -============== - -.. autoclass:: telegram.InputPaidMedia - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpaidmedialivephoto.rst b/docs/source/telegram.inputpaidmedialivephoto.rst deleted file mode 100644 index 62bf1a2dac6..00000000000 --- a/docs/source/telegram.inputpaidmedialivephoto.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputPaidMediaLivePhoto -====================== - -.. autoclass:: telegram.InputPaidMediaLivePhoto - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpaidmediaphoto.rst b/docs/source/telegram.inputpaidmediaphoto.rst deleted file mode 100644 index f8df55823a2..00000000000 --- a/docs/source/telegram.inputpaidmediaphoto.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputPaidMediaPhoto -=================== - -.. autoclass:: telegram.InputPaidMediaPhoto - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpaidmediavideo.rst b/docs/source/telegram.inputpaidmediavideo.rst deleted file mode 100644 index 8a3789f5028..00000000000 --- a/docs/source/telegram.inputpaidmediavideo.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputPaidMediaVideo -=================== - -.. autoclass:: telegram.InputPaidMediaVideo - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpollmedia.rst b/docs/source/telegram.inputpollmedia.rst index 6178a00d4a4..9ad77737655 100644 --- a/docs/source/telegram.inputpollmedia.rst +++ b/docs/source/telegram.inputpollmedia.rst @@ -1,3 +1,5 @@ +.. This API page is maintained manually and is not generated by docs.auxil.api_docs. + InputPollMedia ============== diff --git a/docs/source/telegram.inputpolloption.rst b/docs/source/telegram.inputpolloption.rst deleted file mode 100644 index 51a2aab5a3b..00000000000 --- a/docs/source/telegram.inputpolloption.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputPollOption -=============== - -.. autoclass:: telegram.InputPollOption - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputpolloptionmedia.rst b/docs/source/telegram.inputpolloptionmedia.rst index 2af6693ad19..0ee677a61a4 100644 --- a/docs/source/telegram.inputpolloptionmedia.rst +++ b/docs/source/telegram.inputpolloptionmedia.rst @@ -1,3 +1,5 @@ +.. This API page is maintained manually and is not generated by docs.auxil.api_docs. + InputPollOptionMedia ==================== diff --git a/docs/source/telegram.inputprofilephoto.rst b/docs/source/telegram.inputprofilephoto.rst deleted file mode 100644 index 723f3c92389..00000000000 --- a/docs/source/telegram.inputprofilephoto.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputProfilePhoto -================= - -.. autoclass:: telegram.InputProfilePhoto - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputprofilephotoanimated.rst b/docs/source/telegram.inputprofilephotoanimated.rst deleted file mode 100644 index c192d0d8e58..00000000000 --- a/docs/source/telegram.inputprofilephotoanimated.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputProfilePhotoAnimated -========================= - -.. autoclass:: telegram.InputProfilePhotoAnimated - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputprofilephotostatic.rst b/docs/source/telegram.inputprofilephotostatic.rst deleted file mode 100644 index 49b498c13ba..00000000000 --- a/docs/source/telegram.inputprofilephotostatic.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputProfilePhotoStatic -======================= - -.. autoclass:: telegram.InputProfilePhotoStatic - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputsticker.rst b/docs/source/telegram.inputsticker.rst deleted file mode 100644 index f0dd593ae8b..00000000000 --- a/docs/source/telegram.inputsticker.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputSticker -============ - -.. autoclass:: telegram.InputSticker - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputstorycontent.rst b/docs/source/telegram.inputstorycontent.rst deleted file mode 100644 index 3406e8cf253..00000000000 --- a/docs/source/telegram.inputstorycontent.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputStoryContent -================= - -.. autoclass:: telegram.InputStoryContent - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputstorycontentphoto.rst b/docs/source/telegram.inputstorycontentphoto.rst deleted file mode 100644 index 1adacb2322c..00000000000 --- a/docs/source/telegram.inputstorycontentphoto.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputStoryContentPhoto -====================== - -.. autoclass:: telegram.InputStoryContentPhoto - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputstorycontentvideo.rst b/docs/source/telegram.inputstorycontentvideo.rst deleted file mode 100644 index 27550468e3b..00000000000 --- a/docs/source/telegram.inputstorycontentvideo.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputStoryContentVideo -====================== - -.. autoclass:: telegram.InputStoryContentVideo - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputtextmessagecontent.rst b/docs/source/telegram.inputtextmessagecontent.rst deleted file mode 100644 index 652a6bef135..00000000000 --- a/docs/source/telegram.inputtextmessagecontent.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputTextMessageContent -======================= - -.. autoclass:: telegram.InputTextMessageContent - :members: - :show-inheritance: diff --git a/docs/source/telegram.inputvenuemessagecontent.rst b/docs/source/telegram.inputvenuemessagecontent.rst deleted file mode 100644 index 678be16e654..00000000000 --- a/docs/source/telegram.inputvenuemessagecontent.rst +++ /dev/null @@ -1,6 +0,0 @@ -InputVenueMessageContent -======================== - -.. autoclass:: telegram.InputVenueMessageContent - :members: - :show-inheritance: diff --git a/docs/source/telegram.invoice.rst b/docs/source/telegram.invoice.rst deleted file mode 100644 index 0033452af7a..00000000000 --- a/docs/source/telegram.invoice.rst +++ /dev/null @@ -1,6 +0,0 @@ -Invoice -======= - -.. autoclass:: telegram.Invoice - :members: - :show-inheritance: diff --git a/docs/source/telegram.keyboardbutton.rst b/docs/source/telegram.keyboardbutton.rst deleted file mode 100644 index ccc5ebb7c43..00000000000 --- a/docs/source/telegram.keyboardbutton.rst +++ /dev/null @@ -1,6 +0,0 @@ -KeyboardButton -============== - -.. autoclass:: telegram.KeyboardButton - :members: - :show-inheritance: diff --git a/docs/source/telegram.keyboardbuttonpolltype.rst b/docs/source/telegram.keyboardbuttonpolltype.rst deleted file mode 100644 index 44d0d13e4e6..00000000000 --- a/docs/source/telegram.keyboardbuttonpolltype.rst +++ /dev/null @@ -1,6 +0,0 @@ -KeyboardButtonPollType -====================== - -.. autoclass:: telegram.KeyboardButtonPollType - :members: - :show-inheritance: diff --git a/docs/source/telegram.keyboardbuttonrequestchat.rst b/docs/source/telegram.keyboardbuttonrequestchat.rst deleted file mode 100644 index d902b27c0d1..00000000000 --- a/docs/source/telegram.keyboardbuttonrequestchat.rst +++ /dev/null @@ -1,6 +0,0 @@ -KeyboardButtonRequestChat -================================== - -.. autoclass:: telegram.KeyboardButtonRequestChat - :members: - :show-inheritance: diff --git a/docs/source/telegram.keyboardbuttonrequestmanagedbot.rst b/docs/source/telegram.keyboardbuttonrequestmanagedbot.rst deleted file mode 100644 index 2840249e15d..00000000000 --- a/docs/source/telegram.keyboardbuttonrequestmanagedbot.rst +++ /dev/null @@ -1,6 +0,0 @@ -KeyboardButtonRequestManagedBot -=============================== - -.. autoclass:: telegram.KeyboardButtonRequestManagedBot - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.keyboardbuttonrequestusers.rst b/docs/source/telegram.keyboardbuttonrequestusers.rst deleted file mode 100644 index a56e9fb4316..00000000000 --- a/docs/source/telegram.keyboardbuttonrequestusers.rst +++ /dev/null @@ -1,6 +0,0 @@ -KeyboardButtonRequestUsers -========================== - -.. autoclass:: telegram.KeyboardButtonRequestUsers - :members: - :show-inheritance: diff --git a/docs/source/telegram.labeledprice.rst b/docs/source/telegram.labeledprice.rst deleted file mode 100644 index 18ec28c0da9..00000000000 --- a/docs/source/telegram.labeledprice.rst +++ /dev/null @@ -1,6 +0,0 @@ -LabeledPrice -============ - -.. autoclass:: telegram.LabeledPrice - :members: - :show-inheritance: diff --git a/docs/source/telegram.linkpreviewoptions.rst b/docs/source/telegram.linkpreviewoptions.rst deleted file mode 100644 index 53b46cdcf80..00000000000 --- a/docs/source/telegram.linkpreviewoptions.rst +++ /dev/null @@ -1,6 +0,0 @@ -LinkPreviewOptions -================== - -.. autoclass:: telegram.LinkPreviewOptions - :members: - :show-inheritance: diff --git a/docs/source/telegram.livephoto.rst b/docs/source/telegram.livephoto.rst deleted file mode 100644 index 969e4b4db4c..00000000000 --- a/docs/source/telegram.livephoto.rst +++ /dev/null @@ -1,6 +0,0 @@ -LivePhoto -========= - -.. autoclass:: telegram.LivePhoto - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.location.rst b/docs/source/telegram.location.rst deleted file mode 100644 index 5240b32477f..00000000000 --- a/docs/source/telegram.location.rst +++ /dev/null @@ -1,6 +0,0 @@ -Location -======== - -.. autoclass:: telegram.Location - :members: - :show-inheritance: diff --git a/docs/source/telegram.locationaddress.rst b/docs/source/telegram.locationaddress.rst deleted file mode 100644 index f6e3874de9d..00000000000 --- a/docs/source/telegram.locationaddress.rst +++ /dev/null @@ -1,6 +0,0 @@ -LocationAddress -=============== - -.. autoclass:: telegram.LocationAddress - :members: - :show-inheritance: diff --git a/docs/source/telegram.loginurl.rst b/docs/source/telegram.loginurl.rst deleted file mode 100644 index 382b44de51b..00000000000 --- a/docs/source/telegram.loginurl.rst +++ /dev/null @@ -1,6 +0,0 @@ -LoginUrl -======== - -.. autoclass:: telegram.LoginUrl - :members: - :show-inheritance: diff --git a/docs/source/telegram.managedbotcreated.rst b/docs/source/telegram.managedbotcreated.rst deleted file mode 100644 index e137de86830..00000000000 --- a/docs/source/telegram.managedbotcreated.rst +++ /dev/null @@ -1,6 +0,0 @@ -ManagedBotCreated -================= - -.. autoclass:: telegram.ManagedBotCreated - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.managedbotupdated.rst b/docs/source/telegram.managedbotupdated.rst deleted file mode 100644 index f47bd6b60cc..00000000000 --- a/docs/source/telegram.managedbotupdated.rst +++ /dev/null @@ -1,6 +0,0 @@ -ManagedBotUpdated -================= - -.. autoclass:: telegram.ManagedBotUpdated - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.maskposition.rst b/docs/source/telegram.maskposition.rst deleted file mode 100644 index 469693dbe3a..00000000000 --- a/docs/source/telegram.maskposition.rst +++ /dev/null @@ -1,6 +0,0 @@ -MaskPosition -============ - -.. autoclass:: telegram.MaskPosition - :members: - :show-inheritance: diff --git a/docs/source/telegram.maybeinaccessiblemessage.rst b/docs/source/telegram.maybeinaccessiblemessage.rst deleted file mode 100644 index 920d757c487..00000000000 --- a/docs/source/telegram.maybeinaccessiblemessage.rst +++ /dev/null @@ -1,6 +0,0 @@ -MaybeInaccessibleMessage -======================== - -.. autoclass:: telegram.MaybeInaccessibleMessage - :members: - :show-inheritance: diff --git a/docs/source/telegram.menubutton.rst b/docs/source/telegram.menubutton.rst deleted file mode 100644 index 63a0935b026..00000000000 --- a/docs/source/telegram.menubutton.rst +++ /dev/null @@ -1,6 +0,0 @@ -MenuButton -========== - -.. autoclass:: telegram.MenuButton - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.menubuttoncommands.rst b/docs/source/telegram.menubuttoncommands.rst deleted file mode 100644 index bc44e738f96..00000000000 --- a/docs/source/telegram.menubuttoncommands.rst +++ /dev/null @@ -1,6 +0,0 @@ -MenuButtonCommands -================== - -.. autoclass:: telegram.MenuButtonCommands - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.menubuttondefault.rst b/docs/source/telegram.menubuttondefault.rst deleted file mode 100644 index 31924b088fe..00000000000 --- a/docs/source/telegram.menubuttondefault.rst +++ /dev/null @@ -1,6 +0,0 @@ -MenuButtonDefault -================= - -.. autoclass:: telegram.MenuButtonDefault - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.menubuttonwebapp.rst b/docs/source/telegram.menubuttonwebapp.rst deleted file mode 100644 index 6eba96a239f..00000000000 --- a/docs/source/telegram.menubuttonwebapp.rst +++ /dev/null @@ -1,6 +0,0 @@ -MenuButtonWebApp -================ - -.. autoclass:: telegram.MenuButtonWebApp - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.message.rst b/docs/source/telegram.message.rst deleted file mode 100644 index 83eea631455..00000000000 --- a/docs/source/telegram.message.rst +++ /dev/null @@ -1,6 +0,0 @@ -Message -======= - -.. autoclass:: telegram.Message - :members: - :show-inheritance: diff --git a/docs/source/telegram.messageautodeletetimerchanged.rst b/docs/source/telegram.messageautodeletetimerchanged.rst deleted file mode 100644 index 69658f3c659..00000000000 --- a/docs/source/telegram.messageautodeletetimerchanged.rst +++ /dev/null @@ -1,6 +0,0 @@ -MessageAutoDeleteTimerChanged -============================= - -.. autoclass:: telegram.MessageAutoDeleteTimerChanged - :members: - :show-inheritance: diff --git a/docs/source/telegram.messageentity.rst b/docs/source/telegram.messageentity.rst deleted file mode 100644 index 1d669f0e7a5..00000000000 --- a/docs/source/telegram.messageentity.rst +++ /dev/null @@ -1,6 +0,0 @@ -MessageEntity -============= - -.. autoclass:: telegram.MessageEntity - :members: - :show-inheritance: diff --git a/docs/source/telegram.messageid.rst b/docs/source/telegram.messageid.rst deleted file mode 100644 index a4a7b8b16b2..00000000000 --- a/docs/source/telegram.messageid.rst +++ /dev/null @@ -1,6 +0,0 @@ -MessageId -========= - -.. autoclass:: telegram.MessageId - :members: - :show-inheritance: diff --git a/docs/source/telegram.messageorigin.rst b/docs/source/telegram.messageorigin.rst deleted file mode 100644 index ed0cf6905e2..00000000000 --- a/docs/source/telegram.messageorigin.rst +++ /dev/null @@ -1,6 +0,0 @@ -MessageOrigin -============= - -.. autoclass:: telegram.MessageOrigin - :members: - :show-inheritance: diff --git a/docs/source/telegram.messageoriginchannel.rst b/docs/source/telegram.messageoriginchannel.rst deleted file mode 100644 index bddd957a3f3..00000000000 --- a/docs/source/telegram.messageoriginchannel.rst +++ /dev/null @@ -1,6 +0,0 @@ -MessageOriginChannel -==================== - -.. autoclass:: telegram.MessageOriginChannel - :members: - :show-inheritance: diff --git a/docs/source/telegram.messageoriginchat.rst b/docs/source/telegram.messageoriginchat.rst deleted file mode 100644 index 928572446aa..00000000000 --- a/docs/source/telegram.messageoriginchat.rst +++ /dev/null @@ -1,6 +0,0 @@ -MessageOriginChat -================= - -.. autoclass:: telegram.MessageOriginChat - :members: - :show-inheritance: diff --git a/docs/source/telegram.messageoriginhiddenuser.rst b/docs/source/telegram.messageoriginhiddenuser.rst deleted file mode 100644 index 7556a94f00c..00000000000 --- a/docs/source/telegram.messageoriginhiddenuser.rst +++ /dev/null @@ -1,7 +0,0 @@ -MessageOriginHiddenUser -======================= - -.. autoclass:: telegram.MessageOriginHiddenUser - :members: - :show-inheritance: - diff --git a/docs/source/telegram.messageoriginuser.rst b/docs/source/telegram.messageoriginuser.rst deleted file mode 100644 index 365bb455d17..00000000000 --- a/docs/source/telegram.messageoriginuser.rst +++ /dev/null @@ -1,6 +0,0 @@ -MessageOriginUser -================= - -.. autoclass:: telegram.MessageOriginUser - :members: - :show-inheritance: diff --git a/docs/source/telegram.messagereactioncountupdated.rst b/docs/source/telegram.messagereactioncountupdated.rst deleted file mode 100644 index 4a0aead1e81..00000000000 --- a/docs/source/telegram.messagereactioncountupdated.rst +++ /dev/null @@ -1,6 +0,0 @@ -MessageReactionCountUpdated -=========================== - -.. autoclass:: telegram.MessageReactionCountUpdated - :members: - :show-inheritance: diff --git a/docs/source/telegram.messagereactionupdated.rst b/docs/source/telegram.messagereactionupdated.rst deleted file mode 100644 index 7110fb23fee..00000000000 --- a/docs/source/telegram.messagereactionupdated.rst +++ /dev/null @@ -1,6 +0,0 @@ -MessageReactionUpdated -====================== - -.. autoclass:: telegram.MessageReactionUpdated - :members: - :show-inheritance: diff --git a/docs/source/telegram.orderinfo.rst b/docs/source/telegram.orderinfo.rst deleted file mode 100644 index 4826a584f63..00000000000 --- a/docs/source/telegram.orderinfo.rst +++ /dev/null @@ -1,6 +0,0 @@ -OrderInfo -========= - -.. autoclass:: telegram.OrderInfo - :members: - :show-inheritance: diff --git a/docs/source/telegram.ownedgift.rst b/docs/source/telegram.ownedgift.rst deleted file mode 100644 index 0c726895c07..00000000000 --- a/docs/source/telegram.ownedgift.rst +++ /dev/null @@ -1,6 +0,0 @@ -OwnedGift -========= - -.. autoclass:: telegram.OwnedGift - :members: - :show-inheritance: diff --git a/docs/source/telegram.ownedgiftregular.rst b/docs/source/telegram.ownedgiftregular.rst deleted file mode 100644 index eb4f3641ed6..00000000000 --- a/docs/source/telegram.ownedgiftregular.rst +++ /dev/null @@ -1,6 +0,0 @@ -OwnedGiftRegular -================ - -.. autoclass:: telegram.OwnedGiftRegular - :members: - :show-inheritance: diff --git a/docs/source/telegram.ownedgifts.rst b/docs/source/telegram.ownedgifts.rst deleted file mode 100644 index 71a1c51b86f..00000000000 --- a/docs/source/telegram.ownedgifts.rst +++ /dev/null @@ -1,6 +0,0 @@ -OwnedGifts -========== - -.. autoclass:: telegram.OwnedGifts - :members: - :show-inheritance: diff --git a/docs/source/telegram.ownedgiftunique.rst b/docs/source/telegram.ownedgiftunique.rst deleted file mode 100644 index cc114fecc49..00000000000 --- a/docs/source/telegram.ownedgiftunique.rst +++ /dev/null @@ -1,6 +0,0 @@ -OwnedGiftUnique -=============== - -.. autoclass:: telegram.OwnedGiftUnique - :members: - :show-inheritance: diff --git a/docs/source/telegram.paidmedia.rst b/docs/source/telegram.paidmedia.rst deleted file mode 100644 index 0883310f324..00000000000 --- a/docs/source/telegram.paidmedia.rst +++ /dev/null @@ -1,6 +0,0 @@ -PaidMedia -========= - -.. autoclass:: telegram.PaidMedia - :members: - :show-inheritance: diff --git a/docs/source/telegram.paidmediainfo.rst b/docs/source/telegram.paidmediainfo.rst deleted file mode 100644 index 3c0d1e75c52..00000000000 --- a/docs/source/telegram.paidmediainfo.rst +++ /dev/null @@ -1,6 +0,0 @@ -PaidMediaInfo -============= - -.. autoclass:: telegram.PaidMediaInfo - :members: - :show-inheritance: diff --git a/docs/source/telegram.paidmedialivephoto.rst b/docs/source/telegram.paidmedialivephoto.rst deleted file mode 100644 index 12fe8058ce9..00000000000 --- a/docs/source/telegram.paidmedialivephoto.rst +++ /dev/null @@ -1,6 +0,0 @@ -PaidMediaLivePhoto -================== - -.. autoclass:: telegram.PaidMediaLivePhoto - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmediaphoto.rst b/docs/source/telegram.paidmediaphoto.rst deleted file mode 100644 index 4092cfcc187..00000000000 --- a/docs/source/telegram.paidmediaphoto.rst +++ /dev/null @@ -1,6 +0,0 @@ -PaidMediaPhoto -============== - -.. autoclass:: telegram.PaidMediaPhoto - :members: - :show-inheritance: diff --git a/docs/source/telegram.paidmediapreview.rst b/docs/source/telegram.paidmediapreview.rst deleted file mode 100644 index 32ff4809d69..00000000000 --- a/docs/source/telegram.paidmediapreview.rst +++ /dev/null @@ -1,6 +0,0 @@ -PaidMediaPreview -================ - -.. autoclass:: telegram.PaidMediaPreview - :members: - :show-inheritance: diff --git a/docs/source/telegram.paidmediapurchased.rst b/docs/source/telegram.paidmediapurchased.rst deleted file mode 100644 index 80568ae405c..00000000000 --- a/docs/source/telegram.paidmediapurchased.rst +++ /dev/null @@ -1,6 +0,0 @@ -PaidMediaPurchased -================== - -.. autoclass:: telegram.PaidMediaPurchased - :members: - :show-inheritance: diff --git a/docs/source/telegram.paidmediavideo.rst b/docs/source/telegram.paidmediavideo.rst deleted file mode 100644 index 30f2377ac86..00000000000 --- a/docs/source/telegram.paidmediavideo.rst +++ /dev/null @@ -1,6 +0,0 @@ -PaidMediaVideo -============== - -.. autoclass:: telegram.PaidMediaVideo - :members: - :show-inheritance: diff --git a/docs/source/telegram.paidmessagepricechanged.rst b/docs/source/telegram.paidmessagepricechanged.rst deleted file mode 100644 index 3d0e739c456..00000000000 --- a/docs/source/telegram.paidmessagepricechanged.rst +++ /dev/null @@ -1,6 +0,0 @@ -PaidMessagePriceChanged -======================= - -.. autoclass:: telegram.PaidMessagePriceChanged - :members: - :show-inheritance: diff --git a/docs/source/telegram.passportdata.rst b/docs/source/telegram.passportdata.rst deleted file mode 100644 index 8fad1edb2f5..00000000000 --- a/docs/source/telegram.passportdata.rst +++ /dev/null @@ -1,6 +0,0 @@ -PassportData -============ - -.. autoclass:: telegram.PassportData - :members: - :show-inheritance: diff --git a/docs/source/telegram.passportelementerror.rst b/docs/source/telegram.passportelementerror.rst deleted file mode 100644 index f2a5ccbd678..00000000000 --- a/docs/source/telegram.passportelementerror.rst +++ /dev/null @@ -1,6 +0,0 @@ -PassportElementError -==================== - -.. autoclass:: telegram.PassportElementError - :members: - :show-inheritance: diff --git a/docs/source/telegram.passportelementerrordatafield.rst b/docs/source/telegram.passportelementerrordatafield.rst deleted file mode 100644 index a697f70fe8c..00000000000 --- a/docs/source/telegram.passportelementerrordatafield.rst +++ /dev/null @@ -1,6 +0,0 @@ -PassportElementErrorDataField -============================= - -.. autoclass:: telegram.PassportElementErrorDataField - :members: - :show-inheritance: diff --git a/docs/source/telegram.passportelementerrorfile.rst b/docs/source/telegram.passportelementerrorfile.rst deleted file mode 100644 index 28117533268..00000000000 --- a/docs/source/telegram.passportelementerrorfile.rst +++ /dev/null @@ -1,6 +0,0 @@ -PassportElementErrorFile -======================== - -.. autoclass:: telegram.PassportElementErrorFile - :members: - :show-inheritance: diff --git a/docs/source/telegram.passportelementerrorfiles.rst b/docs/source/telegram.passportelementerrorfiles.rst deleted file mode 100644 index b537e33473a..00000000000 --- a/docs/source/telegram.passportelementerrorfiles.rst +++ /dev/null @@ -1,6 +0,0 @@ -PassportElementErrorFiles -========================= - -.. autoclass:: telegram.PassportElementErrorFiles - :members: - :show-inheritance: diff --git a/docs/source/telegram.passportelementerrorfrontside.rst b/docs/source/telegram.passportelementerrorfrontside.rst deleted file mode 100644 index 0b3126f852d..00000000000 --- a/docs/source/telegram.passportelementerrorfrontside.rst +++ /dev/null @@ -1,6 +0,0 @@ -PassportElementErrorFrontSide -============================= - -.. autoclass:: telegram.PassportElementErrorFrontSide - :members: - :show-inheritance: diff --git a/docs/source/telegram.passportelementerrorreverseside.rst b/docs/source/telegram.passportelementerrorreverseside.rst deleted file mode 100644 index 401bced1887..00000000000 --- a/docs/source/telegram.passportelementerrorreverseside.rst +++ /dev/null @@ -1,6 +0,0 @@ -PassportElementErrorReverseSide -=============================== - -.. autoclass:: telegram.PassportElementErrorReverseSide - :members: - :show-inheritance: diff --git a/docs/source/telegram.passportelementerrorselfie.rst b/docs/source/telegram.passportelementerrorselfie.rst deleted file mode 100644 index ce5b2f2bdcf..00000000000 --- a/docs/source/telegram.passportelementerrorselfie.rst +++ /dev/null @@ -1,6 +0,0 @@ -PassportElementErrorSelfie -========================== - -.. autoclass:: telegram.PassportElementErrorSelfie - :members: - :show-inheritance: diff --git a/docs/source/telegram.passportelementerrortranslationfile.rst b/docs/source/telegram.passportelementerrortranslationfile.rst deleted file mode 100644 index 4aa055b752f..00000000000 --- a/docs/source/telegram.passportelementerrortranslationfile.rst +++ /dev/null @@ -1,6 +0,0 @@ -PassportElementErrorTranslationFile -=================================== - -.. autoclass:: telegram.PassportElementErrorTranslationFile - :members: - :show-inheritance: diff --git a/docs/source/telegram.passportelementerrortranslationfiles.rst b/docs/source/telegram.passportelementerrortranslationfiles.rst deleted file mode 100644 index 36c4e223eda..00000000000 --- a/docs/source/telegram.passportelementerrortranslationfiles.rst +++ /dev/null @@ -1,6 +0,0 @@ -PassportElementErrorTranslationFiles -==================================== - -.. autoclass:: telegram.PassportElementErrorTranslationFiles - :members: - :show-inheritance: diff --git a/docs/source/telegram.passportelementerrorunspecified.rst b/docs/source/telegram.passportelementerrorunspecified.rst deleted file mode 100644 index be3987822c9..00000000000 --- a/docs/source/telegram.passportelementerrorunspecified.rst +++ /dev/null @@ -1,6 +0,0 @@ -PassportElementErrorUnspecified -=============================== - -.. autoclass:: telegram.PassportElementErrorUnspecified - :members: - :show-inheritance: diff --git a/docs/source/telegram.passportfile.rst b/docs/source/telegram.passportfile.rst deleted file mode 100644 index 643ba3df897..00000000000 --- a/docs/source/telegram.passportfile.rst +++ /dev/null @@ -1,6 +0,0 @@ -PassportFile -============ - -.. autoclass:: telegram.PassportFile - :members: - :show-inheritance: diff --git a/docs/source/telegram.personaldetails.rst b/docs/source/telegram.personaldetails.rst deleted file mode 100644 index dfe4408c150..00000000000 --- a/docs/source/telegram.personaldetails.rst +++ /dev/null @@ -1,6 +0,0 @@ -PersonalDetails -=============== - -.. autoclass:: telegram.PersonalDetails - :members: - :show-inheritance: diff --git a/docs/source/telegram.photosize.rst b/docs/source/telegram.photosize.rst deleted file mode 100644 index 53632ac9bd4..00000000000 --- a/docs/source/telegram.photosize.rst +++ /dev/null @@ -1,8 +0,0 @@ -PhotoSize -========= -.. Also lists methods of _BaseMedium, but not the ones of TelegramObject - -.. autoclass:: telegram.PhotoSize - :members: - :show-inheritance: - :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.poll.rst b/docs/source/telegram.poll.rst deleted file mode 100644 index 705215d9d12..00000000000 --- a/docs/source/telegram.poll.rst +++ /dev/null @@ -1,6 +0,0 @@ -Poll -==== - -.. autoclass:: telegram.Poll - :members: - :show-inheritance: diff --git a/docs/source/telegram.pollanswer.rst b/docs/source/telegram.pollanswer.rst deleted file mode 100644 index 211d8abf752..00000000000 --- a/docs/source/telegram.pollanswer.rst +++ /dev/null @@ -1,6 +0,0 @@ -PollAnswer -========== - -.. autoclass:: telegram.PollAnswer - :members: - :show-inheritance: diff --git a/docs/source/telegram.pollmedia.rst b/docs/source/telegram.pollmedia.rst deleted file mode 100644 index 8e7b38871b4..00000000000 --- a/docs/source/telegram.pollmedia.rst +++ /dev/null @@ -1,6 +0,0 @@ -PollMedia -========= - -.. autoclass:: telegram.PollMedia - :members: - :show-inheritance: diff --git a/docs/source/telegram.polloption.rst b/docs/source/telegram.polloption.rst deleted file mode 100644 index 264f00f5217..00000000000 --- a/docs/source/telegram.polloption.rst +++ /dev/null @@ -1,6 +0,0 @@ -PollOption -========== - -.. autoclass:: telegram.PollOption - :members: - :show-inheritance: diff --git a/docs/source/telegram.polloptionadded.rst b/docs/source/telegram.polloptionadded.rst deleted file mode 100644 index fa4638c38f0..00000000000 --- a/docs/source/telegram.polloptionadded.rst +++ /dev/null @@ -1,6 +0,0 @@ -PollOptionAdded -=============== - -.. autoclass:: telegram.PollOptionAdded - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.polloptiondeleted.rst b/docs/source/telegram.polloptiondeleted.rst deleted file mode 100644 index 74f317f5604..00000000000 --- a/docs/source/telegram.polloptiondeleted.rst +++ /dev/null @@ -1,6 +0,0 @@ -PollOptionDeleted -================= - -.. autoclass:: telegram.PollOptionDeleted - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.precheckoutquery.rst b/docs/source/telegram.precheckoutquery.rst deleted file mode 100644 index 4d2ed627ac9..00000000000 --- a/docs/source/telegram.precheckoutquery.rst +++ /dev/null @@ -1,6 +0,0 @@ -PreCheckoutQuery -================ - -.. autoclass:: telegram.PreCheckoutQuery - :members: - :show-inheritance: diff --git a/docs/source/telegram.preparedinlinemessage.rst b/docs/source/telegram.preparedinlinemessage.rst deleted file mode 100644 index 2522f8c58cf..00000000000 --- a/docs/source/telegram.preparedinlinemessage.rst +++ /dev/null @@ -1,6 +0,0 @@ -PreparedInlineMessage -===================== - -.. autoclass:: telegram.PreparedInlineMessage - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.preparedkeyboardbutton.rst b/docs/source/telegram.preparedkeyboardbutton.rst deleted file mode 100644 index 7a1f40481b5..00000000000 --- a/docs/source/telegram.preparedkeyboardbutton.rst +++ /dev/null @@ -1,6 +0,0 @@ -PreparedKeyboardButton -====================== - -.. autoclass:: telegram.PreparedKeyboardButton - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.proximityalerttriggered.rst b/docs/source/telegram.proximityalerttriggered.rst deleted file mode 100644 index 7e80117c5ab..00000000000 --- a/docs/source/telegram.proximityalerttriggered.rst +++ /dev/null @@ -1,6 +0,0 @@ -ProximityAlertTriggered -======================= - -.. autoclass:: telegram.ProximityAlertTriggered - :members: - :show-inheritance: diff --git a/docs/source/telegram.reactioncount.rst b/docs/source/telegram.reactioncount.rst deleted file mode 100644 index f93a4b760b8..00000000000 --- a/docs/source/telegram.reactioncount.rst +++ /dev/null @@ -1,6 +0,0 @@ -ReactionCount -============= - -.. autoclass:: telegram.ReactionCount - :members: - :show-inheritance: diff --git a/docs/source/telegram.reactiontype.rst b/docs/source/telegram.reactiontype.rst deleted file mode 100644 index c726049312a..00000000000 --- a/docs/source/telegram.reactiontype.rst +++ /dev/null @@ -1,6 +0,0 @@ -ReactionType -============ - -.. autoclass:: telegram.ReactionType - :members: - :show-inheritance: diff --git a/docs/source/telegram.reactiontypecustomemoji.rst b/docs/source/telegram.reactiontypecustomemoji.rst deleted file mode 100644 index e4faf95d9e5..00000000000 --- a/docs/source/telegram.reactiontypecustomemoji.rst +++ /dev/null @@ -1,6 +0,0 @@ -ReactionTypeCustomEmoji -======================= - -.. autoclass:: telegram.ReactionTypeCustomEmoji - :members: - :show-inheritance: diff --git a/docs/source/telegram.reactiontypeemoji.rst b/docs/source/telegram.reactiontypeemoji.rst deleted file mode 100644 index cebad3665da..00000000000 --- a/docs/source/telegram.reactiontypeemoji.rst +++ /dev/null @@ -1,6 +0,0 @@ -ReactionTypeEmoji -================= - -.. autoclass:: telegram.ReactionTypeEmoji - :members: - :show-inheritance: diff --git a/docs/source/telegram.reactiontypepaid.rst b/docs/source/telegram.reactiontypepaid.rst deleted file mode 100644 index f5035a1ba5b..00000000000 --- a/docs/source/telegram.reactiontypepaid.rst +++ /dev/null @@ -1,6 +0,0 @@ -ReactionTypePaid -================ - -.. autoclass:: telegram.ReactionTypePaid - :members: - :show-inheritance: diff --git a/docs/source/telegram.refundedpayment.rst b/docs/source/telegram.refundedpayment.rst deleted file mode 100644 index f99349c859c..00000000000 --- a/docs/source/telegram.refundedpayment.rst +++ /dev/null @@ -1,6 +0,0 @@ -RefundedPayment -=============== - -.. autoclass:: telegram.RefundedPayment - :members: - :show-inheritance: diff --git a/docs/source/telegram.replykeyboardmarkup.rst b/docs/source/telegram.replykeyboardmarkup.rst deleted file mode 100644 index 395124b3c7b..00000000000 --- a/docs/source/telegram.replykeyboardmarkup.rst +++ /dev/null @@ -1,6 +0,0 @@ -ReplyKeyboardMarkup -=================== - -.. autoclass:: telegram.ReplyKeyboardMarkup - :members: - :show-inheritance: diff --git a/docs/source/telegram.replykeyboardremove.rst b/docs/source/telegram.replykeyboardremove.rst deleted file mode 100644 index e1e4bb30db2..00000000000 --- a/docs/source/telegram.replykeyboardremove.rst +++ /dev/null @@ -1,6 +0,0 @@ -ReplyKeyboardRemove -=================== - -.. autoclass:: telegram.ReplyKeyboardRemove - :members: - :show-inheritance: diff --git a/docs/source/telegram.replyparameters.rst b/docs/source/telegram.replyparameters.rst deleted file mode 100644 index efe32e10441..00000000000 --- a/docs/source/telegram.replyparameters.rst +++ /dev/null @@ -1,6 +0,0 @@ -ReplyParameters -=============== - -.. autoclass:: telegram.ReplyParameters - :members: - :show-inheritance: diff --git a/docs/source/telegram.request.baserequest.rst b/docs/source/telegram.request.baserequest.rst deleted file mode 100644 index f3510e5f14f..00000000000 --- a/docs/source/telegram.request.baserequest.rst +++ /dev/null @@ -1,6 +0,0 @@ -BaseRequest -=========== - -.. autoclass:: telegram.request.BaseRequest - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.request.httpxrequest.rst b/docs/source/telegram.request.httpxrequest.rst deleted file mode 100644 index 9c1441821ae..00000000000 --- a/docs/source/telegram.request.httpxrequest.rst +++ /dev/null @@ -1,6 +0,0 @@ -HTTPXRequest -============ - -.. autoclass:: telegram.request.HTTPXRequest - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.request.requestdata.rst b/docs/source/telegram.request.requestdata.rst deleted file mode 100644 index 189a1929170..00000000000 --- a/docs/source/telegram.request.requestdata.rst +++ /dev/null @@ -1,6 +0,0 @@ -RequestData -=========== - -.. autoclass:: telegram.request.RequestData - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.request.rst b/docs/source/telegram.request.rst index 22292c70d72..198c01bbd4c 100644 --- a/docs/source/telegram.request.rst +++ b/docs/source/telegram.request.rst @@ -3,9 +3,4 @@ telegram.request Module .. versionadded:: 20.0 -.. toctree:: - :titlesonly: - - telegram.request.baserequest - telegram.request.requestdata - telegram.request.httpxrequest +.. ptb-api-toctree:: request diff --git a/docs/source/telegram.residentialaddress.rst b/docs/source/telegram.residentialaddress.rst deleted file mode 100644 index 00fea575646..00000000000 --- a/docs/source/telegram.residentialaddress.rst +++ /dev/null @@ -1,6 +0,0 @@ -ResidentialAddress -================== - -.. autoclass:: telegram.ResidentialAddress - :members: - :show-inheritance: diff --git a/docs/source/telegram.revenuewithdrawalstate.rst b/docs/source/telegram.revenuewithdrawalstate.rst deleted file mode 100644 index a8b0d9ef0ef..00000000000 --- a/docs/source/telegram.revenuewithdrawalstate.rst +++ /dev/null @@ -1,6 +0,0 @@ -RevenueWithdrawalState -====================== - -.. autoclass:: telegram.RevenueWithdrawalState - :members: - :show-inheritance: diff --git a/docs/source/telegram.revenuewithdrawalstatefailed.rst b/docs/source/telegram.revenuewithdrawalstatefailed.rst deleted file mode 100644 index 63379122869..00000000000 --- a/docs/source/telegram.revenuewithdrawalstatefailed.rst +++ /dev/null @@ -1,6 +0,0 @@ -RevenueWithdrawalStateFailed -============================= - -.. autoclass:: telegram.RevenueWithdrawalStateFailed - :members: - :show-inheritance: diff --git a/docs/source/telegram.revenuewithdrawalstatepending.rst b/docs/source/telegram.revenuewithdrawalstatepending.rst deleted file mode 100644 index 3c2110271c0..00000000000 --- a/docs/source/telegram.revenuewithdrawalstatepending.rst +++ /dev/null @@ -1,6 +0,0 @@ -RevenueWithdrawalStatePending -============================= - -.. autoclass:: telegram.RevenueWithdrawalStatePending - :members: - :show-inheritance: diff --git a/docs/source/telegram.revenuewithdrawalstatesucceeded.rst b/docs/source/telegram.revenuewithdrawalstatesucceeded.rst deleted file mode 100644 index 40bd6fdb5c7..00000000000 --- a/docs/source/telegram.revenuewithdrawalstatesucceeded.rst +++ /dev/null @@ -1,6 +0,0 @@ -RevenueWithdrawalStateSucceeded -=============================== - -.. autoclass:: telegram.RevenueWithdrawalStateSucceeded - :members: - :show-inheritance: diff --git a/docs/source/telegram.securedata.rst b/docs/source/telegram.securedata.rst deleted file mode 100644 index 9396fdfec75..00000000000 --- a/docs/source/telegram.securedata.rst +++ /dev/null @@ -1,6 +0,0 @@ -SecureData -========== - -.. autoclass:: telegram.SecureData - :members: - :show-inheritance: diff --git a/docs/source/telegram.securevalue.rst b/docs/source/telegram.securevalue.rst deleted file mode 100644 index 105bd8580c0..00000000000 --- a/docs/source/telegram.securevalue.rst +++ /dev/null @@ -1,6 +0,0 @@ -SecureValue -=========== - -.. autoclass:: telegram.SecureValue - :members: - :show-inheritance: diff --git a/docs/source/telegram.sentguestmessage.rst b/docs/source/telegram.sentguestmessage.rst deleted file mode 100644 index b63e0735029..00000000000 --- a/docs/source/telegram.sentguestmessage.rst +++ /dev/null @@ -1,6 +0,0 @@ -SentGuestMessage -================ - -.. autoclass:: telegram.SentGuestMessage - :members: - :show-inheritance: diff --git a/docs/source/telegram.sentwebappmessage.rst b/docs/source/telegram.sentwebappmessage.rst deleted file mode 100644 index 1fd1dd0ab72..00000000000 --- a/docs/source/telegram.sentwebappmessage.rst +++ /dev/null @@ -1,6 +0,0 @@ -SentWebAppMessage -================= - -.. autoclass:: telegram.SentWebAppMessage - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.shareduser.rst b/docs/source/telegram.shareduser.rst deleted file mode 100644 index 52dd3885bc0..00000000000 --- a/docs/source/telegram.shareduser.rst +++ /dev/null @@ -1,7 +0,0 @@ -SharedUser -========== - -.. autoclass:: telegram.SharedUser - :members: - :show-inheritance: - diff --git a/docs/source/telegram.shippingaddress.rst b/docs/source/telegram.shippingaddress.rst deleted file mode 100644 index 7704e957fdc..00000000000 --- a/docs/source/telegram.shippingaddress.rst +++ /dev/null @@ -1,6 +0,0 @@ -ShippingAddress -=============== - -.. autoclass:: telegram.ShippingAddress - :members: - :show-inheritance: diff --git a/docs/source/telegram.shippingoption.rst b/docs/source/telegram.shippingoption.rst deleted file mode 100644 index 45359c77613..00000000000 --- a/docs/source/telegram.shippingoption.rst +++ /dev/null @@ -1,6 +0,0 @@ -ShippingOption -============== - -.. autoclass:: telegram.ShippingOption - :members: - :show-inheritance: diff --git a/docs/source/telegram.shippingquery.rst b/docs/source/telegram.shippingquery.rst deleted file mode 100644 index 400809e260c..00000000000 --- a/docs/source/telegram.shippingquery.rst +++ /dev/null @@ -1,6 +0,0 @@ -ShippingQuery -============= - -.. autoclass:: telegram.ShippingQuery - :members: - :show-inheritance: diff --git a/docs/source/telegram.staramount.rst b/docs/source/telegram.staramount.rst deleted file mode 100644 index 9d5a6e24572..00000000000 --- a/docs/source/telegram.staramount.rst +++ /dev/null @@ -1,6 +0,0 @@ -StarAmount -========== - -.. autoclass:: telegram.StarAmount - :members: - :show-inheritance: diff --git a/docs/source/telegram.startransaction.rst b/docs/source/telegram.startransaction.rst deleted file mode 100644 index b8a68c8e99e..00000000000 --- a/docs/source/telegram.startransaction.rst +++ /dev/null @@ -1,6 +0,0 @@ -StarTransaction -=============== - -.. autoclass:: telegram.StarTransaction - :members: - :show-inheritance: diff --git a/docs/source/telegram.startransactions.rst b/docs/source/telegram.startransactions.rst deleted file mode 100644 index e71439c8c87..00000000000 --- a/docs/source/telegram.startransactions.rst +++ /dev/null @@ -1,7 +0,0 @@ -StarTransactions -================ - -.. autoclass:: telegram.StarTransactions - :members: - :show-inheritance: - diff --git a/docs/source/telegram.sticker.rst b/docs/source/telegram.sticker.rst deleted file mode 100644 index 459629b7ecc..00000000000 --- a/docs/source/telegram.sticker.rst +++ /dev/null @@ -1,9 +0,0 @@ -Sticker -======= - -.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject - -.. autoclass:: telegram.Sticker - :members: - :show-inheritance: - :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.stickerset.rst b/docs/source/telegram.stickerset.rst deleted file mode 100644 index 83ec00e16cb..00000000000 --- a/docs/source/telegram.stickerset.rst +++ /dev/null @@ -1,6 +0,0 @@ -StickerSet -========== - -.. autoclass:: telegram.StickerSet - :members: - :show-inheritance: diff --git a/docs/source/telegram.story.rst b/docs/source/telegram.story.rst deleted file mode 100644 index 6b3b28d4a64..00000000000 --- a/docs/source/telegram.story.rst +++ /dev/null @@ -1,6 +0,0 @@ -Story -===== - -.. autoclass:: telegram.Story - :members: - :show-inheritance: diff --git a/docs/source/telegram.storyarea.rst b/docs/source/telegram.storyarea.rst deleted file mode 100644 index 88c028535d6..00000000000 --- a/docs/source/telegram.storyarea.rst +++ /dev/null @@ -1,6 +0,0 @@ -StoryArea -========= - -.. autoclass:: telegram.StoryArea - :members: - :show-inheritance: diff --git a/docs/source/telegram.storyareaposition.rst b/docs/source/telegram.storyareaposition.rst deleted file mode 100644 index d14aa66cb2a..00000000000 --- a/docs/source/telegram.storyareaposition.rst +++ /dev/null @@ -1,6 +0,0 @@ -StoryAreaPosition -================= - -.. autoclass:: telegram.StoryAreaPosition - :members: - :show-inheritance: diff --git a/docs/source/telegram.storyareatype.rst b/docs/source/telegram.storyareatype.rst deleted file mode 100644 index aa4ad3312aa..00000000000 --- a/docs/source/telegram.storyareatype.rst +++ /dev/null @@ -1,6 +0,0 @@ -StoryAreaType -============= - -.. autoclass:: telegram.StoryAreaType - :members: - :show-inheritance: diff --git a/docs/source/telegram.storyareatypelink.rst b/docs/source/telegram.storyareatypelink.rst deleted file mode 100644 index 493eeef5da2..00000000000 --- a/docs/source/telegram.storyareatypelink.rst +++ /dev/null @@ -1,6 +0,0 @@ -StoryAreaTypeLink -================= - -.. autoclass:: telegram.StoryAreaTypeLink - :members: - :show-inheritance: diff --git a/docs/source/telegram.storyareatypelocation.rst b/docs/source/telegram.storyareatypelocation.rst deleted file mode 100644 index 8f09ee9bf40..00000000000 --- a/docs/source/telegram.storyareatypelocation.rst +++ /dev/null @@ -1,6 +0,0 @@ -StoryAreaTypeLocation -===================== - -.. autoclass:: telegram.StoryAreaTypeLocation - :members: - :show-inheritance: diff --git a/docs/source/telegram.storyareatypesuggestedreaction.rst b/docs/source/telegram.storyareatypesuggestedreaction.rst deleted file mode 100644 index e099e992d61..00000000000 --- a/docs/source/telegram.storyareatypesuggestedreaction.rst +++ /dev/null @@ -1,6 +0,0 @@ -StoryAreaTypeSuggestedReaction -============================== - -.. autoclass:: telegram.StoryAreaTypeSuggestedReaction - :members: - :show-inheritance: diff --git a/docs/source/telegram.storyareatypeuniquegift.rst b/docs/source/telegram.storyareatypeuniquegift.rst deleted file mode 100644 index c6e7fd9a119..00000000000 --- a/docs/source/telegram.storyareatypeuniquegift.rst +++ /dev/null @@ -1,6 +0,0 @@ -StoryAreaTypeUniqueGift -======================= - -.. autoclass:: telegram.StoryAreaTypeUniqueGift - :members: - :show-inheritance: diff --git a/docs/source/telegram.storyareatypeweather.rst b/docs/source/telegram.storyareatypeweather.rst deleted file mode 100644 index a704e7eecfd..00000000000 --- a/docs/source/telegram.storyareatypeweather.rst +++ /dev/null @@ -1,6 +0,0 @@ -StoryAreaTypeWeather -==================== - -.. autoclass:: telegram.StoryAreaTypeWeather - :members: - :show-inheritance: diff --git a/docs/source/telegram.successfulpayment.rst b/docs/source/telegram.successfulpayment.rst deleted file mode 100644 index 19b1e6db53d..00000000000 --- a/docs/source/telegram.successfulpayment.rst +++ /dev/null @@ -1,6 +0,0 @@ -SuccessfulPayment -================= - -.. autoclass:: telegram.SuccessfulPayment - :members: - :show-inheritance: diff --git a/docs/source/telegram.suggestedpostapprovalfailed.rst b/docs/source/telegram.suggestedpostapprovalfailed.rst deleted file mode 100644 index 5b730f18583..00000000000 --- a/docs/source/telegram.suggestedpostapprovalfailed.rst +++ /dev/null @@ -1,6 +0,0 @@ -SuggestedPostApprovalFailed -=========================== - -.. autoclass:: telegram.SuggestedPostApprovalFailed - :members: - :show-inheritance: diff --git a/docs/source/telegram.suggestedpostapproved.rst b/docs/source/telegram.suggestedpostapproved.rst deleted file mode 100644 index c9e74a94652..00000000000 --- a/docs/source/telegram.suggestedpostapproved.rst +++ /dev/null @@ -1,6 +0,0 @@ -SuggestedPostApproved -===================== - -.. autoclass:: telegram.SuggestedPostApproved - :members: - :show-inheritance: diff --git a/docs/source/telegram.suggestedpostdeclined.rst b/docs/source/telegram.suggestedpostdeclined.rst deleted file mode 100644 index bf9194d074b..00000000000 --- a/docs/source/telegram.suggestedpostdeclined.rst +++ /dev/null @@ -1,6 +0,0 @@ -SuggestedPostDeclined -===================== - -.. autoclass:: telegram.SuggestedPostDeclined - :members: - :show-inheritance: diff --git a/docs/source/telegram.suggestedpostinfo.rst b/docs/source/telegram.suggestedpostinfo.rst deleted file mode 100644 index a974dda9887..00000000000 --- a/docs/source/telegram.suggestedpostinfo.rst +++ /dev/null @@ -1,6 +0,0 @@ -SuggestedPostInfo -================= - -.. autoclass:: telegram.SuggestedPostInfo - :members: - :show-inheritance: diff --git a/docs/source/telegram.suggestedpostpaid.rst b/docs/source/telegram.suggestedpostpaid.rst deleted file mode 100644 index 6eb4a57bbda..00000000000 --- a/docs/source/telegram.suggestedpostpaid.rst +++ /dev/null @@ -1,6 +0,0 @@ -SuggestedPostPaid -================= - -.. autoclass:: telegram.SuggestedPostPaid - :members: - :show-inheritance: diff --git a/docs/source/telegram.suggestedpostparameters.rst b/docs/source/telegram.suggestedpostparameters.rst deleted file mode 100644 index 5111d8fdd48..00000000000 --- a/docs/source/telegram.suggestedpostparameters.rst +++ /dev/null @@ -1,6 +0,0 @@ -SuggestedPostParameters -======================= - -.. autoclass:: telegram.SuggestedPostParameters - :members: - :show-inheritance: diff --git a/docs/source/telegram.suggestedpostprice.rst b/docs/source/telegram.suggestedpostprice.rst deleted file mode 100644 index f5034e8f047..00000000000 --- a/docs/source/telegram.suggestedpostprice.rst +++ /dev/null @@ -1,6 +0,0 @@ -SuggestedPostPrice -================== - -.. autoclass:: telegram.SuggestedPostPrice - :members: - :show-inheritance: diff --git a/docs/source/telegram.suggestedpostrefunded.rst b/docs/source/telegram.suggestedpostrefunded.rst deleted file mode 100644 index 2fb5ad1beff..00000000000 --- a/docs/source/telegram.suggestedpostrefunded.rst +++ /dev/null @@ -1,6 +0,0 @@ -SuggestedPostRefunded -===================== - -.. autoclass:: telegram.SuggestedPostRefunded - :members: - :show-inheritance: diff --git a/docs/source/telegram.switchinlinequerychosenchat.rst b/docs/source/telegram.switchinlinequerychosenchat.rst deleted file mode 100644 index 603a56f6ad2..00000000000 --- a/docs/source/telegram.switchinlinequerychosenchat.rst +++ /dev/null @@ -1,6 +0,0 @@ -SwitchInlineQueryChosenChat -=========================== - -.. autoclass:: telegram.SwitchInlineQueryChosenChat - :members: - :show-inheritance: diff --git a/docs/source/telegram.telegramobject.rst b/docs/source/telegram.telegramobject.rst deleted file mode 100644 index 7f1e5dbb7fa..00000000000 --- a/docs/source/telegram.telegramobject.rst +++ /dev/null @@ -1,6 +0,0 @@ -TelegramObject -============== - -.. autoclass:: telegram.TelegramObject - :members: - :show-inheritance: diff --git a/docs/source/telegram.textquote.rst b/docs/source/telegram.textquote.rst deleted file mode 100644 index 4e11ff74132..00000000000 --- a/docs/source/telegram.textquote.rst +++ /dev/null @@ -1,6 +0,0 @@ -TextQuote -========= - -.. autoclass:: telegram.TextQuote - :members: - :show-inheritance: diff --git a/docs/source/telegram.transactionpartner.rst b/docs/source/telegram.transactionpartner.rst deleted file mode 100644 index 1970cfb3f94..00000000000 --- a/docs/source/telegram.transactionpartner.rst +++ /dev/null @@ -1,6 +0,0 @@ -TransactionPartner -================== - -.. autoclass:: telegram.TransactionPartner - :members: - :show-inheritance: diff --git a/docs/source/telegram.transactionpartneraffiliateprogram.rst b/docs/source/telegram.transactionpartneraffiliateprogram.rst deleted file mode 100644 index dfcab6ec22b..00000000000 --- a/docs/source/telegram.transactionpartneraffiliateprogram.rst +++ /dev/null @@ -1,6 +0,0 @@ -TransactionPartnerAffiliateProgram -=================================== - -.. autoclass:: telegram.TransactionPartnerAffiliateProgram - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartnerchat.rst b/docs/source/telegram.transactionpartnerchat.rst deleted file mode 100644 index 3f278f05d80..00000000000 --- a/docs/source/telegram.transactionpartnerchat.rst +++ /dev/null @@ -1,6 +0,0 @@ -TransactionPartnerChat -====================== - -.. autoclass:: telegram.TransactionPartnerChat - :members: - :show-inheritance: diff --git a/docs/source/telegram.transactionpartnerfragment.rst b/docs/source/telegram.transactionpartnerfragment.rst deleted file mode 100644 index dbdad66f2df..00000000000 --- a/docs/source/telegram.transactionpartnerfragment.rst +++ /dev/null @@ -1,6 +0,0 @@ -TransactionPartnerFragment -========================== - -.. autoclass:: telegram.TransactionPartnerFragment - :members: - :show-inheritance: diff --git a/docs/source/telegram.transactionpartnerother.rst b/docs/source/telegram.transactionpartnerother.rst deleted file mode 100644 index cbc4c41be52..00000000000 --- a/docs/source/telegram.transactionpartnerother.rst +++ /dev/null @@ -1,6 +0,0 @@ -TransactionPartnerOther -======================= - -.. autoclass:: telegram.TransactionPartnerOther - :members: - :show-inheritance: diff --git a/docs/source/telegram.transactionpartnertelegramads.rst b/docs/source/telegram.transactionpartnertelegramads.rst deleted file mode 100644 index 8304bc84a06..00000000000 --- a/docs/source/telegram.transactionpartnertelegramads.rst +++ /dev/null @@ -1,6 +0,0 @@ -TransactionPartnerTelegramAds -============================= - -.. autoclass:: telegram.TransactionPartnerTelegramAds - :members: - :show-inheritance: diff --git a/docs/source/telegram.transactionpartnertelegramapi.rst b/docs/source/telegram.transactionpartnertelegramapi.rst deleted file mode 100644 index 619b4a0c89f..00000000000 --- a/docs/source/telegram.transactionpartnertelegramapi.rst +++ /dev/null @@ -1,6 +0,0 @@ -TransactionPartnerTelegramApi -============================= - -.. autoclass:: telegram.TransactionPartnerTelegramApi - :members: - :show-inheritance: diff --git a/docs/source/telegram.transactionpartneruser.rst b/docs/source/telegram.transactionpartneruser.rst deleted file mode 100644 index 7709bd668c4..00000000000 --- a/docs/source/telegram.transactionpartneruser.rst +++ /dev/null @@ -1,6 +0,0 @@ -TransactionPartnerUser -====================== - -.. autoclass:: telegram.TransactionPartnerUser - :members: - :show-inheritance: diff --git a/docs/source/telegram.uniquegift.rst b/docs/source/telegram.uniquegift.rst deleted file mode 100644 index 0d9d1a12d32..00000000000 --- a/docs/source/telegram.uniquegift.rst +++ /dev/null @@ -1,7 +0,0 @@ -UniqueGift -========== - -.. autoclass:: telegram.UniqueGift - :members: - :show-inheritance: - diff --git a/docs/source/telegram.uniquegiftbackdrop.rst b/docs/source/telegram.uniquegiftbackdrop.rst deleted file mode 100644 index 52264731b22..00000000000 --- a/docs/source/telegram.uniquegiftbackdrop.rst +++ /dev/null @@ -1,7 +0,0 @@ -UniqueGiftBackdrop -================== - -.. autoclass:: telegram.UniqueGiftBackdrop - :members: - :show-inheritance: - diff --git a/docs/source/telegram.uniquegiftbackdropcolors.rst b/docs/source/telegram.uniquegiftbackdropcolors.rst deleted file mode 100644 index 40fbf609a37..00000000000 --- a/docs/source/telegram.uniquegiftbackdropcolors.rst +++ /dev/null @@ -1,7 +0,0 @@ -UniqueGiftBackdropColors -======================== - -.. autoclass:: telegram.UniqueGiftBackdropColors - :members: - :show-inheritance: - diff --git a/docs/source/telegram.uniquegiftcolors.rst b/docs/source/telegram.uniquegiftcolors.rst deleted file mode 100644 index 3e554abd8de..00000000000 --- a/docs/source/telegram.uniquegiftcolors.rst +++ /dev/null @@ -1,7 +0,0 @@ -UniqueGiftColors -================ - -.. autoclass:: telegram.UniqueGiftColors - :members: - :show-inheritance: - diff --git a/docs/source/telegram.uniquegiftinfo.rst b/docs/source/telegram.uniquegiftinfo.rst deleted file mode 100644 index 5d8ef6402cf..00000000000 --- a/docs/source/telegram.uniquegiftinfo.rst +++ /dev/null @@ -1,7 +0,0 @@ -UniqueGiftInfo -============== - -.. autoclass:: telegram.UniqueGiftInfo - :members: - :show-inheritance: - diff --git a/docs/source/telegram.uniquegiftmodel.rst b/docs/source/telegram.uniquegiftmodel.rst deleted file mode 100644 index a0a95a04307..00000000000 --- a/docs/source/telegram.uniquegiftmodel.rst +++ /dev/null @@ -1,7 +0,0 @@ -UniqueGiftModel -=============== - -.. autoclass:: telegram.UniqueGiftModel - :members: - :show-inheritance: - diff --git a/docs/source/telegram.uniquegiftsymbol.rst b/docs/source/telegram.uniquegiftsymbol.rst deleted file mode 100644 index 8246da5cf17..00000000000 --- a/docs/source/telegram.uniquegiftsymbol.rst +++ /dev/null @@ -1,7 +0,0 @@ -UniqueGiftSymbol -================ - -.. autoclass:: telegram.UniqueGiftSymbol - :members: - :show-inheritance: - diff --git a/docs/source/telegram.update.rst b/docs/source/telegram.update.rst deleted file mode 100644 index 0c3c3f0f244..00000000000 --- a/docs/source/telegram.update.rst +++ /dev/null @@ -1,6 +0,0 @@ -Update -====== - -.. autoclass:: telegram.Update - :members: - :show-inheritance: diff --git a/docs/source/telegram.user.rst b/docs/source/telegram.user.rst deleted file mode 100644 index 1e138240a79..00000000000 --- a/docs/source/telegram.user.rst +++ /dev/null @@ -1,6 +0,0 @@ -User -==== - -.. autoclass:: telegram.User - :members: - :show-inheritance: diff --git a/docs/source/telegram.userchatboosts.rst b/docs/source/telegram.userchatboosts.rst deleted file mode 100644 index 78b958f0d31..00000000000 --- a/docs/source/telegram.userchatboosts.rst +++ /dev/null @@ -1,8 +0,0 @@ -UserChatBoosts -============== - -.. versionadded:: 20.8 - -.. autoclass:: telegram.UserChatBoosts - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.userprofileaudios.rst b/docs/source/telegram.userprofileaudios.rst deleted file mode 100644 index 19582f504b1..00000000000 --- a/docs/source/telegram.userprofileaudios.rst +++ /dev/null @@ -1,6 +0,0 @@ -UserProfileAudios -================= - -.. autoclass:: telegram.UserProfileAudios - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.userprofilephotos.rst b/docs/source/telegram.userprofilephotos.rst deleted file mode 100644 index d9edd69a019..00000000000 --- a/docs/source/telegram.userprofilephotos.rst +++ /dev/null @@ -1,6 +0,0 @@ -UserProfilePhotos -================= - -.. autoclass:: telegram.UserProfilePhotos - :members: - :show-inheritance: diff --git a/docs/source/telegram.userrating.rst b/docs/source/telegram.userrating.rst deleted file mode 100644 index f4a8db4a068..00000000000 --- a/docs/source/telegram.userrating.rst +++ /dev/null @@ -1,6 +0,0 @@ -UserRating -========== - -.. autoclass:: telegram.UserRating - :members: - :show-inheritance: diff --git a/docs/source/telegram.usersshared.rst b/docs/source/telegram.usersshared.rst deleted file mode 100644 index 5af3457f59e..00000000000 --- a/docs/source/telegram.usersshared.rst +++ /dev/null @@ -1,6 +0,0 @@ -UsersShared -=========== - -.. autoclass:: telegram.UsersShared - :members: - :show-inheritance: diff --git a/docs/source/telegram.venue.rst b/docs/source/telegram.venue.rst deleted file mode 100644 index f54e598a0dd..00000000000 --- a/docs/source/telegram.venue.rst +++ /dev/null @@ -1,6 +0,0 @@ -Venue -===== - -.. autoclass:: telegram.Venue - :members: - :show-inheritance: diff --git a/docs/source/telegram.video.rst b/docs/source/telegram.video.rst deleted file mode 100644 index bcda1026431..00000000000 --- a/docs/source/telegram.video.rst +++ /dev/null @@ -1,9 +0,0 @@ -Video -===== - -.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject - -.. autoclass:: telegram.Video - :members: - :show-inheritance: - :inherited-members: TelegramObject, object \ No newline at end of file diff --git a/docs/source/telegram.videochatended.rst b/docs/source/telegram.videochatended.rst deleted file mode 100644 index 02ba5742b3f..00000000000 --- a/docs/source/telegram.videochatended.rst +++ /dev/null @@ -1,7 +0,0 @@ -VideoChatEnded -============== - -.. autoclass:: telegram.VideoChatEnded - :members: - :show-inheritance: - diff --git a/docs/source/telegram.videochatparticipantsinvited.rst b/docs/source/telegram.videochatparticipantsinvited.rst deleted file mode 100644 index 84f30143053..00000000000 --- a/docs/source/telegram.videochatparticipantsinvited.rst +++ /dev/null @@ -1,7 +0,0 @@ -VideoChatParticipantsInvited -============================ - -.. autoclass:: telegram.VideoChatParticipantsInvited - :members: - :show-inheritance: - diff --git a/docs/source/telegram.videochatscheduled.rst b/docs/source/telegram.videochatscheduled.rst deleted file mode 100644 index 0e69b89949c..00000000000 --- a/docs/source/telegram.videochatscheduled.rst +++ /dev/null @@ -1,6 +0,0 @@ -VideoChatScheduled -================== - -.. autoclass:: telegram.VideoChatScheduled - :members: - :show-inheritance: diff --git a/docs/source/telegram.videochatstarted.rst b/docs/source/telegram.videochatstarted.rst deleted file mode 100644 index 005dde65ee9..00000000000 --- a/docs/source/telegram.videochatstarted.rst +++ /dev/null @@ -1,7 +0,0 @@ -VideoChatStarted -================ - -.. autoclass:: telegram.VideoChatStarted - :members: - :show-inheritance: - diff --git a/docs/source/telegram.videonote.rst b/docs/source/telegram.videonote.rst deleted file mode 100644 index e7b504fb515..00000000000 --- a/docs/source/telegram.videonote.rst +++ /dev/null @@ -1,9 +0,0 @@ -VideoNote -========= - -.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject - -.. autoclass:: telegram.VideoNote - :members: - :show-inheritance: - :inherited-members: TelegramObject, object \ No newline at end of file diff --git a/docs/source/telegram.videoquality.rst b/docs/source/telegram.videoquality.rst deleted file mode 100644 index da1583d7bfe..00000000000 --- a/docs/source/telegram.videoquality.rst +++ /dev/null @@ -1,8 +0,0 @@ -VideoQuality -============ -.. Also lists methods of _BaseMedium, but not the ones of TelegramObject - -.. autoclass:: telegram.VideoQuality - :members: - :show-inheritance: - :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.voice.rst b/docs/source/telegram.voice.rst deleted file mode 100644 index b1530967bd2..00000000000 --- a/docs/source/telegram.voice.rst +++ /dev/null @@ -1,9 +0,0 @@ -Voice -===== - -.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject - -.. autoclass:: telegram.Voice - :members: - :show-inheritance: - :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.webappdata.rst b/docs/source/telegram.webappdata.rst deleted file mode 100644 index 003414419c8..00000000000 --- a/docs/source/telegram.webappdata.rst +++ /dev/null @@ -1,6 +0,0 @@ -WebAppData -========== - -.. autoclass:: telegram.WebAppData - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.webappinfo.rst b/docs/source/telegram.webappinfo.rst deleted file mode 100644 index 85423c2c5f0..00000000000 --- a/docs/source/telegram.webappinfo.rst +++ /dev/null @@ -1,6 +0,0 @@ -WebAppInfo -========== - -.. autoclass:: telegram.WebAppInfo - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.webhookinfo.rst b/docs/source/telegram.webhookinfo.rst deleted file mode 100644 index b58027ec015..00000000000 --- a/docs/source/telegram.webhookinfo.rst +++ /dev/null @@ -1,6 +0,0 @@ -WebhookInfo -=========== - -.. autoclass:: telegram.WebhookInfo - :members: - :show-inheritance: diff --git a/docs/source/telegram.writeaccessallowed.rst b/docs/source/telegram.writeaccessallowed.rst deleted file mode 100644 index 81ffffa1625..00000000000 --- a/docs/source/telegram.writeaccessallowed.rst +++ /dev/null @@ -1,6 +0,0 @@ -WriteAccessAllowed -================== - -.. autoclass:: telegram.WriteAccessAllowed - :members: - :show-inheritance: diff --git a/src/telegram/_chatboost.py b/src/telegram/_chatboost.py index 2386f2e6a5c..928179a23fd 100644 --- a/src/telegram/_chatboost.py +++ b/src/telegram/_chatboost.py @@ -351,6 +351,8 @@ class ChatBoostRemoved(TelegramObject): considered equal, if their :attr:`chat`, :attr:`boost_id`, :attr:`remove_date`, and :attr:`source` are equal. + .. versionadded:: 20.8 + Args: chat (:class:`telegram.Chat`): Chat which was boosted. boost_id (:obj:`str`): Unique identifier of the boost. From 041a0bc101c7a179ef0b25dcbc05bc29016edef7 Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Tue, 4 Aug 2026 04:00:46 -0400 Subject: [PATCH 2/4] Remove AI slop, organize .rst files into folders --- .github/CONTRIBUTING.rst | 10 - .gitignore | 23 - docs/auxil/api_docs.py | 605 +++++++++++------- docs/source/_templates/ptb-object.rst | 5 +- docs/source/conf.py | 3 + .../examples.arbitrarycallbackdatabot.rst | 8 +- docs/source/examples.chatmemberbot.rst | 8 +- docs/source/examples.contexttypesbot.rst | 8 +- docs/source/examples.conversationbot.rst | 14 +- docs/source/examples.conversationbot2.rst | 14 +- docs/source/examples.customwebhookbot.rst | 44 +- docs/source/examples.deeplinking.rst | 8 +- docs/source/examples.echobot.rst | 8 +- docs/source/examples.errorhandlerbot.rst | 8 +- docs/source/examples.inlinebot.rst | 8 +- docs/source/examples.inlinekeyboard.rst | 8 +- docs/source/examples.inlinekeyboard2.rst | 8 +- .../source/examples.nestedconversationbot.rst | 14 +- docs/source/examples.passportbot.rst | 17 +- docs/source/examples.paymentbot.rst | 8 +- .../examples.persistentconversationbot.rst | 8 +- docs/source/examples.pollbot.rst | 8 +- docs/source/examples.rawapibot.rst | 12 +- docs/source/examples.rst | 197 +----- docs/source/examples.timerbot.rst | 8 +- docs/source/examples.webappbot.rst | 17 +- .../examples/arbitrarycallbackdatabot.rst | 8 + docs/source/examples/chatmemberbot.rst | 8 + docs/source/examples/contexttypesbot.rst | 8 + docs/source/examples/conversationbot.rst | 15 + docs/source/examples/conversationbot2.rst | 15 + docs/source/examples/customwebhookbot.rst | 44 ++ docs/source/examples/deeplinking.rst | 8 + docs/source/examples/echobot.rst | 8 + docs/source/examples/errorhandlerbot.rst | 8 + docs/source/examples/index.rst | 197 ++++++ docs/source/examples/inlinebot.rst | 8 + docs/source/examples/inlinekeyboard.rst | 8 + docs/source/examples/inlinekeyboard2.rst | 8 + .../source/examples/nestedconversationbot.rst | 15 + docs/source/examples/passportbot.rst | 17 + docs/source/examples/paymentbot.rst | 8 + .../examples/persistentconversationbot.rst | 8 + docs/source/examples/pollbot.rst | 8 + docs/source/examples/rawapibot.rst | 12 + docs/source/examples/timerbot.rst | 8 + docs/source/examples/webappbot.rst | 17 + docs/source/telegram.acceptedgifttypes.rst | 10 + docs/source/telegram.affiliateinfo.rst | 10 + docs/source/telegram.animation.rst | 10 + docs/source/telegram.at-tree.rst | 4 +- docs/source/telegram.audio.rst | 10 + docs/source/telegram.backgroundfill.rst | 10 + ...elegram.backgroundfillfreeformgradient.rst | 10 + .../telegram.backgroundfillgradient.rst | 10 + docs/source/telegram.backgroundfillsolid.rst | 10 + docs/source/telegram.backgroundtype.rst | 10 + .../telegram.backgroundtypechattheme.rst | 10 + docs/source/telegram.backgroundtypefill.rst | 10 + .../source/telegram.backgroundtypepattern.rst | 10 + .../telegram.backgroundtypewallpaper.rst | 10 + docs/source/telegram.birthdate.rst | 10 + docs/source/telegram.bot.rst | 10 + docs/source/telegram.botaccesssettings.rst | 10 + docs/source/telegram.botcommand.rst | 10 + docs/source/telegram.botcommandscope.rst | 10 + ...m.botcommandscopeallchatadministrators.rst | 10 + .../telegram.botcommandscopeallgroupchats.rst | 10 + ...elegram.botcommandscopeallprivatechats.rst | 10 + docs/source/telegram.botcommandscopechat.rst | 10 + ...gram.botcommandscopechatadministrators.rst | 10 + .../telegram.botcommandscopechatmember.rst | 10 + .../telegram.botcommandscopedefault.rst | 10 + docs/source/telegram.botdescription.rst | 10 + docs/source/telegram.botname.rst | 10 + docs/source/telegram.botshortdescription.rst | 10 + docs/source/telegram.businessbotrights.rst | 10 + docs/source/telegram.businessconnection.rst | 10 + docs/source/telegram.businessintro.rst | 10 + docs/source/telegram.businesslocation.rst | 10 + .../telegram.businessmessagesdeleted.rst | 10 + docs/source/telegram.businessopeninghours.rst | 10 + .../telegram.businessopeninghoursinterval.rst | 10 + docs/source/telegram.callbackgame.rst | 10 + docs/source/telegram.callbackquery.rst | 10 + docs/source/telegram.chat.rst | 3 + .../telegram.chatadministratorrights.rst | 10 + docs/source/telegram.chatbackground.rst | 10 + docs/source/telegram.chatboost.rst | 10 + docs/source/telegram.chatboostadded.rst | 10 + docs/source/telegram.chatboostremoved.rst | 10 + docs/source/telegram.chatboostsource.rst | 10 + .../telegram.chatboostsourcegiftcode.rst | 10 + .../telegram.chatboostsourcegiveaway.rst | 10 + .../telegram.chatboostsourcepremium.rst | 10 + docs/source/telegram.chatboostupdated.rst | 10 + docs/source/telegram.chatfullinfo.rst | 3 + docs/source/telegram.chatinvitelink.rst | 10 + docs/source/telegram.chatjoinrequest.rst | 10 + docs/source/telegram.chatlocation.rst | 10 + docs/source/telegram.chatmember.rst | 10 + .../telegram.chatmemberadministrator.rst | 10 + docs/source/telegram.chatmemberbanned.rst | 10 + docs/source/telegram.chatmemberleft.rst | 10 + docs/source/telegram.chatmembermember.rst | 10 + docs/source/telegram.chatmemberowner.rst | 10 + docs/source/telegram.chatmemberrestricted.rst | 10 + docs/source/telegram.chatmemberupdated.rst | 10 + docs/source/telegram.chatownerchanged.rst | 10 + docs/source/telegram.chatownerleft.rst | 10 + docs/source/telegram.chatpermissions.rst | 10 + docs/source/telegram.chatphoto.rst | 10 + docs/source/telegram.chatshared.rst | 10 + docs/source/telegram.checklist.rst | 10 + docs/source/telegram.checklisttask.rst | 10 + docs/source/telegram.checklisttasksadded.rst | 10 + docs/source/telegram.checklisttasksdone.rst | 10 + docs/source/telegram.choseninlineresult.rst | 10 + docs/source/telegram.constants.rst | 9 +- docs/source/telegram.contact.rst | 10 + docs/source/telegram.copytextbutton.rst | 10 + docs/source/telegram.credentials.rst | 10 + docs/source/telegram.datacredentials.rst | 10 + docs/source/telegram.dice.rst | 10 + .../telegram.directmessagepricechanged.rst | 10 + docs/source/telegram.directmessagestopic.rst | 10 + docs/source/telegram.document.rst | 10 + docs/source/telegram.encryptedcredentials.rst | 10 + .../telegram.encryptedpassportelement.rst | 10 + docs/source/telegram.error.rst | 7 +- docs/source/telegram.ext.acd-tree.rst | 10 +- docs/source/telegram.ext.aioratelimiter.rst | 10 + docs/source/telegram.ext.application.rst | 10 + .../telegram.ext.applicationbuilder.rst | 3 + .../telegram.ext.applicationhandlerstop.rst | 10 + docs/source/telegram.ext.basehandler.rst | 10 + docs/source/telegram.ext.basepersistence.rst | 10 + docs/source/telegram.ext.baseratelimiter.rst | 10 + .../telegram.ext.baseupdateprocessor.rst | 10 + ...telegram.ext.businessconnectionhandler.rst | 10 + ...ram.ext.businessmessagesdeletedhandler.rst | 10 + docs/source/telegram.ext.callbackcontext.rst | 3 + .../source/telegram.ext.callbackdatacache.rst | 10 + .../telegram.ext.callbackqueryhandler.rst | 10 + docs/source/telegram.ext.chatboosthandler.rst | 10 + .../telegram.ext.chatjoinrequesthandler.rst | 10 + .../source/telegram.ext.chatmemberhandler.rst | 10 + ...telegram.ext.choseninlineresulthandler.rst | 10 + docs/source/telegram.ext.commandhandler.rst | 10 + docs/source/telegram.ext.contexttypes.rst | 10 + .../telegram.ext.conversationhandler.rst | 10 + docs/source/telegram.ext.defaults.rst | 10 + docs/source/telegram.ext.dictpersistence.rst | 10 + docs/source/telegram.ext.extbot.rst | 3 + docs/source/telegram.ext.filters.rst | 12 +- docs/source/telegram.ext.handlers-tree.rst | 32 +- .../telegram.ext.inlinequeryhandler.rst | 10 + .../telegram.ext.invalidcallbackdata.rst | 10 + docs/source/telegram.ext.job.rst | 10 + docs/source/telegram.ext.jobqueue.rst | 10 + .../telegram.ext.managedbotupdatedhandler.rst | 10 + docs/source/telegram.ext.messagehandler.rst | 10 + .../telegram.ext.messagereactionhandler.rst | 10 + ...telegram.ext.paidmediapurchasedhandler.rst | 10 + docs/source/telegram.ext.persistence-tree.rst | 12 +- docs/source/telegram.ext.persistenceinput.rst | 3 + .../source/telegram.ext.picklepersistence.rst | 10 + .../source/telegram.ext.pollanswerhandler.rst | 10 + docs/source/telegram.ext.pollhandler.rst | 10 + .../telegram.ext.precheckoutqueryhandler.rst | 10 + docs/source/telegram.ext.prefixhandler.rst | 10 + .../telegram.ext.rate-limiting-tree.rst | 10 +- docs/source/telegram.ext.rst | 7 +- .../telegram.ext.shippingqueryhandler.rst | 10 + .../telegram.ext.simpleupdateprocessor.rst | 10 + .../telegram.ext.stringcommandhandler.rst | 10 + .../telegram.ext.stringregexhandler.rst | 10 + docs/source/telegram.ext.typehandler.rst | 10 + docs/source/telegram.ext.updater.rst | 10 + docs/source/telegram.externalreplyinfo.rst | 10 + docs/source/telegram.file.rst | 10 + docs/source/telegram.filecredentials.rst | 10 + docs/source/telegram.forcereply.rst | 10 + docs/source/telegram.forumtopic.rst | 10 + docs/source/telegram.forumtopicclosed.rst | 10 + docs/source/telegram.forumtopiccreated.rst | 10 + docs/source/telegram.forumtopicedited.rst | 10 + docs/source/telegram.forumtopicreopened.rst | 10 + docs/source/telegram.game.rst | 10 + docs/source/telegram.gamehighscore.rst | 10 + docs/source/telegram.games-tree.rst | 22 +- .../telegram.generalforumtopichidden.rst | 10 + .../telegram.generalforumtopicunhidden.rst | 10 + docs/source/telegram.gift.rst | 10 + docs/source/telegram.giftbackground.rst | 10 + docs/source/telegram.giftinfo.rst | 10 + docs/source/telegram.gifts.rst | 10 + docs/source/telegram.giveaway.rst | 10 + docs/source/telegram.giveawaycompleted.rst | 10 + docs/source/telegram.giveawaycreated.rst | 10 + docs/source/telegram.giveawaywinners.rst | 10 + docs/source/telegram.helpers.rst | 7 +- docs/source/telegram.iddocumentdata.rst | 10 + docs/source/telegram.inaccessiblemessage.rst | 10 + docs/source/telegram.inline-tree.rst | 43 +- docs/source/telegram.inlinekeyboardbutton.rst | 10 + docs/source/telegram.inlinekeyboardmarkup.rst | 10 + docs/source/telegram.inlinequery.rst | 10 + docs/source/telegram.inlinequeryresult.rst | 10 + .../telegram.inlinequeryresultarticle.rst | 10 + .../telegram.inlinequeryresultaudio.rst | 10 + .../telegram.inlinequeryresultcachedaudio.rst | 10 + ...legram.inlinequeryresultcacheddocument.rst | 10 + .../telegram.inlinequeryresultcachedgif.rst | 10 + ...legram.inlinequeryresultcachedmpeg4gif.rst | 10 + .../telegram.inlinequeryresultcachedphoto.rst | 10 + ...elegram.inlinequeryresultcachedsticker.rst | 10 + .../telegram.inlinequeryresultcachedvideo.rst | 10 + .../telegram.inlinequeryresultcachedvoice.rst | 10 + .../telegram.inlinequeryresultcontact.rst | 10 + .../telegram.inlinequeryresultdocument.rst | 10 + .../source/telegram.inlinequeryresultgame.rst | 10 + docs/source/telegram.inlinequeryresultgif.rst | 10 + .../telegram.inlinequeryresultlocation.rst | 10 + .../telegram.inlinequeryresultmpeg4gif.rst | 10 + .../telegram.inlinequeryresultphoto.rst | 10 + .../telegram.inlinequeryresultsbutton.rst | 10 + .../telegram.inlinequeryresultvenue.rst | 10 + .../telegram.inlinequeryresultvideo.rst | 10 + .../telegram.inlinequeryresultvoice.rst | 10 + docs/source/telegram.inputchecklist.rst | 10 + docs/source/telegram.inputchecklisttask.rst | 10 + .../telegram.inputcontactmessagecontent.rst | 10 + docs/source/telegram.inputfile.rst | 10 + .../telegram.inputinvoicemessagecontent.rst | 10 + .../telegram.inputlocationmessagecontent.rst | 10 + docs/source/telegram.inputmedia.rst | 10 + docs/source/telegram.inputmediaanimation.rst | 10 + docs/source/telegram.inputmediaaudio.rst | 10 + docs/source/telegram.inputmediadocument.rst | 10 + docs/source/telegram.inputmedialivephoto.rst | 10 + docs/source/telegram.inputmedialocation.rst | 10 + docs/source/telegram.inputmediaphoto.rst | 10 + docs/source/telegram.inputmediasticker.rst | 10 + docs/source/telegram.inputmediavenue.rst | 10 + docs/source/telegram.inputmediavideo.rst | 10 + docs/source/telegram.inputmessagecontent.rst | 10 + docs/source/telegram.inputpaidmedia.rst | 10 + .../telegram.inputpaidmedialivephoto.rst | 10 + docs/source/telegram.inputpaidmediaphoto.rst | 10 + docs/source/telegram.inputpaidmediavideo.rst | 10 + docs/source/telegram.inputpollmedia.rst | 9 +- docs/source/telegram.inputpolloption.rst | 10 + docs/source/telegram.inputpolloptionmedia.rst | 9 +- docs/source/telegram.inputprofilephoto.rst | 10 + .../telegram.inputprofilephotoanimated.rst | 10 + .../telegram.inputprofilephotostatic.rst | 10 + docs/source/telegram.inputsticker.rst | 10 + docs/source/telegram.inputstorycontent.rst | 10 + .../telegram.inputstorycontentphoto.rst | 10 + .../telegram.inputstorycontentvideo.rst | 10 + .../telegram.inputtextmessagecontent.rst | 10 + .../telegram.inputvenuemessagecontent.rst | 10 + docs/source/telegram.invoice.rst | 10 + docs/source/telegram.keyboardbutton.rst | 10 + .../telegram.keyboardbuttonpolltype.rst | 10 + .../telegram.keyboardbuttonrequestchat.rst | 10 + ...legram.keyboardbuttonrequestmanagedbot.rst | 10 + .../telegram.keyboardbuttonrequestusers.rst | 10 + docs/source/telegram.labeledprice.rst | 10 + docs/source/telegram.linkpreviewoptions.rst | 10 + docs/source/telegram.livephoto.rst | 10 + docs/source/telegram.location.rst | 10 + docs/source/telegram.locationaddress.rst | 10 + docs/source/telegram.loginurl.rst | 10 + docs/source/telegram.managedbotcreated.rst | 10 + docs/source/telegram.managedbotupdated.rst | 10 + docs/source/telegram.maskposition.rst | 10 + .../telegram.maybeinaccessiblemessage.rst | 10 + docs/source/telegram.menubutton.rst | 10 + docs/source/telegram.menubuttoncommands.rst | 10 + docs/source/telegram.menubuttondefault.rst | 10 + docs/source/telegram.menubuttonwebapp.rst | 10 + docs/source/telegram.message.rst | 10 + ...telegram.messageautodeletetimerchanged.rst | 10 + docs/source/telegram.messageentity.rst | 10 + docs/source/telegram.messageid.rst | 10 + docs/source/telegram.messageorigin.rst | 10 + docs/source/telegram.messageoriginchannel.rst | 10 + docs/source/telegram.messageoriginchat.rst | 10 + .../telegram.messageoriginhiddenuser.rst | 10 + docs/source/telegram.messageoriginuser.rst | 10 + .../telegram.messagereactioncountupdated.rst | 10 + .../telegram.messagereactionupdated.rst | 10 + docs/source/telegram.orderinfo.rst | 10 + docs/source/telegram.ownedgift.rst | 10 + docs/source/telegram.ownedgiftregular.rst | 10 + docs/source/telegram.ownedgifts.rst | 10 + docs/source/telegram.ownedgiftunique.rst | 10 + docs/source/telegram.paidmedia.rst | 10 + docs/source/telegram.paidmediainfo.rst | 10 + docs/source/telegram.paidmedialivephoto.rst | 10 + docs/source/telegram.paidmediaphoto.rst | 10 + docs/source/telegram.paidmediapreview.rst | 10 + docs/source/telegram.paidmediapurchased.rst | 10 + docs/source/telegram.paidmediavideo.rst | 10 + .../telegram.paidmessagepricechanged.rst | 10 + docs/source/telegram.passport-tree.rst | 33 +- docs/source/telegram.passportdata.rst | 10 + docs/source/telegram.passportelementerror.rst | 10 + ...telegram.passportelementerrordatafield.rst | 10 + .../telegram.passportelementerrorfile.rst | 10 + .../telegram.passportelementerrorfiles.rst | 10 + ...telegram.passportelementerrorfrontside.rst | 10 + ...legram.passportelementerrorreverseside.rst | 10 + .../telegram.passportelementerrorselfie.rst | 10 + ...am.passportelementerrortranslationfile.rst | 10 + ...m.passportelementerrortranslationfiles.rst | 10 + ...legram.passportelementerrorunspecified.rst | 10 + docs/source/telegram.passportfile.rst | 10 + docs/source/telegram.payments-tree.rst | 34 +- docs/source/telegram.personaldetails.rst | 10 + docs/source/telegram.photosize.rst | 10 + docs/source/telegram.poll.rst | 10 + docs/source/telegram.pollanswer.rst | 10 + docs/source/telegram.pollmedia.rst | 10 + docs/source/telegram.polloption.rst | 10 + docs/source/telegram.polloptionadded.rst | 10 + docs/source/telegram.polloptiondeleted.rst | 10 + docs/source/telegram.precheckoutquery.rst | 10 + .../source/telegram.preparedinlinemessage.rst | 10 + .../telegram.preparedkeyboardbutton.rst | 10 + .../telegram.proximityalerttriggered.rst | 10 + docs/source/telegram.reactioncount.rst | 10 + docs/source/telegram.reactiontype.rst | 10 + .../telegram.reactiontypecustomemoji.rst | 10 + docs/source/telegram.reactiontypeemoji.rst | 10 + docs/source/telegram.reactiontypepaid.rst | 10 + docs/source/telegram.refundedpayment.rst | 10 + docs/source/telegram.replykeyboardmarkup.rst | 10 + docs/source/telegram.replykeyboardremove.rst | 10 + docs/source/telegram.replyparameters.rst | 10 + docs/source/telegram.request.baserequest.rst | 10 + docs/source/telegram.request.httpxrequest.rst | 10 + docs/source/telegram.request.requestdata.rst | 10 + docs/source/telegram.request.rst | 7 +- docs/source/telegram.residentialaddress.rst | 10 + .../telegram.revenuewithdrawalstate.rst | 10 + .../telegram.revenuewithdrawalstatefailed.rst | 10 + ...telegram.revenuewithdrawalstatepending.rst | 10 + ...legram.revenuewithdrawalstatesucceeded.rst | 10 + docs/source/telegram.rst | 24 +- docs/source/telegram.securedata.rst | 10 + docs/source/telegram.securevalue.rst | 10 + docs/source/telegram.sentguestmessage.rst | 10 + docs/source/telegram.sentwebappmessage.rst | 10 + docs/source/telegram.shareduser.rst | 10 + docs/source/telegram.shippingaddress.rst | 10 + docs/source/telegram.shippingoption.rst | 10 + docs/source/telegram.shippingquery.rst | 10 + docs/source/telegram.staramount.rst | 10 + docs/source/telegram.startransaction.rst | 10 + docs/source/telegram.startransactions.rst | 10 + docs/source/telegram.sticker.rst | 10 + docs/source/telegram.stickers-tree.rst | 16 +- docs/source/telegram.stickerset.rst | 10 + docs/source/telegram.story.rst | 10 + docs/source/telegram.storyarea.rst | 10 + docs/source/telegram.storyareaposition.rst | 10 + docs/source/telegram.storyareatype.rst | 10 + docs/source/telegram.storyareatypelink.rst | 10 + .../source/telegram.storyareatypelocation.rst | 10 + ...elegram.storyareatypesuggestedreaction.rst | 10 + .../telegram.storyareatypeuniquegift.rst | 10 + docs/source/telegram.storyareatypeweather.rst | 10 + docs/source/telegram.successfulpayment.rst | 10 + .../telegram.suggestedpostapprovalfailed.rst | 10 + .../source/telegram.suggestedpostapproved.rst | 10 + .../source/telegram.suggestedpostdeclined.rst | 10 + docs/source/telegram.suggestedpostinfo.rst | 10 + docs/source/telegram.suggestedpostpaid.rst | 10 + .../telegram.suggestedpostparameters.rst | 10 + docs/source/telegram.suggestedpostprice.rst | 10 + .../source/telegram.suggestedpostrefunded.rst | 10 + .../telegram.switchinlinequerychosenchat.rst | 10 + docs/source/telegram.telegramobject.rst | 10 + docs/source/telegram.textquote.rst | 10 + docs/source/telegram.transactionpartner.rst | 10 + ...ram.transactionpartneraffiliateprogram.rst | 10 + .../telegram.transactionpartnerchat.rst | 10 + .../telegram.transactionpartnerfragment.rst | 10 + .../telegram.transactionpartnerother.rst | 10 + ...telegram.transactionpartnertelegramads.rst | 10 + ...telegram.transactionpartnertelegramapi.rst | 10 + .../telegram.transactionpartneruser.rst | 10 + docs/source/telegram.uniquegift.rst | 10 + docs/source/telegram.uniquegiftbackdrop.rst | 10 + .../telegram.uniquegiftbackdropcolors.rst | 10 + docs/source/telegram.uniquegiftcolors.rst | 10 + docs/source/telegram.uniquegiftinfo.rst | 10 + docs/source/telegram.uniquegiftmodel.rst | 10 + docs/source/telegram.uniquegiftsymbol.rst | 10 + docs/source/telegram.update.rst | 10 + docs/source/telegram.user.rst | 10 + docs/source/telegram.userchatboosts.rst | 10 + docs/source/telegram.userprofileaudios.rst | 10 + docs/source/telegram.userprofilephotos.rst | 10 + docs/source/telegram.userrating.rst | 10 + docs/source/telegram.usersshared.rst | 10 + docs/source/telegram.venue.rst | 10 + docs/source/telegram.video.rst | 10 + docs/source/telegram.videochatended.rst | 10 + .../telegram.videochatparticipantsinvited.rst | 10 + docs/source/telegram.videochatscheduled.rst | 10 + docs/source/telegram.videochatstarted.rst | 10 + docs/source/telegram.videonote.rst | 10 + docs/source/telegram.videoquality.rst | 10 + docs/source/telegram.voice.rst | 10 + docs/source/telegram.warnings.rst | 7 +- docs/source/telegram.webappdata.rst | 10 + docs/source/telegram.webappinfo.rst | 10 + docs/source/telegram.webhookinfo.rst | 10 + docs/source/telegram.writeaccessallowed.rst | 10 + docs/source/telegram/chat.rst | 10 + docs/source/telegram/chatfullinfo.rst | 10 + docs/source/telegram/constants.rst | 10 + docs/source/telegram/error.rst | 8 + .../telegram/ext/applicationbuilder.rst | 7 + docs/source/telegram/ext/callbackcontext.rst | 7 + docs/source/telegram/ext/extbot.rst | 8 + docs/source/telegram/ext/filters.rst | 13 + docs/source/telegram/ext/index.rst | 6 + docs/source/telegram/ext/persistenceinput.rst | 7 + docs/source/telegram/helpers.rst | 8 + docs/source/telegram/index.rst | 13 + docs/source/telegram/inputpollmedia.rst | 8 + docs/source/telegram/inputpolloptionmedia.rst | 8 + docs/source/telegram/request/index.rst | 6 + docs/source/telegram/warnings.rst | 8 + docs/source/telegram_auxil.rst | 12 +- docs/source/telegram_auxil/index.rst | 4 + 441 files changed, 4557 insertions(+), 943 deletions(-) create mode 100644 docs/source/examples/arbitrarycallbackdatabot.rst create mode 100644 docs/source/examples/chatmemberbot.rst create mode 100644 docs/source/examples/contexttypesbot.rst create mode 100644 docs/source/examples/conversationbot.rst create mode 100644 docs/source/examples/conversationbot2.rst create mode 100644 docs/source/examples/customwebhookbot.rst create mode 100644 docs/source/examples/deeplinking.rst create mode 100644 docs/source/examples/echobot.rst create mode 100644 docs/source/examples/errorhandlerbot.rst create mode 100644 docs/source/examples/index.rst create mode 100644 docs/source/examples/inlinebot.rst create mode 100644 docs/source/examples/inlinekeyboard.rst create mode 100644 docs/source/examples/inlinekeyboard2.rst create mode 100644 docs/source/examples/nestedconversationbot.rst create mode 100644 docs/source/examples/passportbot.rst create mode 100644 docs/source/examples/paymentbot.rst create mode 100644 docs/source/examples/persistentconversationbot.rst create mode 100644 docs/source/examples/pollbot.rst create mode 100644 docs/source/examples/rawapibot.rst create mode 100644 docs/source/examples/timerbot.rst create mode 100644 docs/source/examples/webappbot.rst create mode 100644 docs/source/telegram.acceptedgifttypes.rst create mode 100644 docs/source/telegram.affiliateinfo.rst create mode 100644 docs/source/telegram.animation.rst create mode 100644 docs/source/telegram.audio.rst create mode 100644 docs/source/telegram.backgroundfill.rst create mode 100644 docs/source/telegram.backgroundfillfreeformgradient.rst create mode 100644 docs/source/telegram.backgroundfillgradient.rst create mode 100644 docs/source/telegram.backgroundfillsolid.rst create mode 100644 docs/source/telegram.backgroundtype.rst create mode 100644 docs/source/telegram.backgroundtypechattheme.rst create mode 100644 docs/source/telegram.backgroundtypefill.rst create mode 100644 docs/source/telegram.backgroundtypepattern.rst create mode 100644 docs/source/telegram.backgroundtypewallpaper.rst create mode 100644 docs/source/telegram.birthdate.rst create mode 100644 docs/source/telegram.bot.rst create mode 100644 docs/source/telegram.botaccesssettings.rst create mode 100644 docs/source/telegram.botcommand.rst create mode 100644 docs/source/telegram.botcommandscope.rst create mode 100644 docs/source/telegram.botcommandscopeallchatadministrators.rst create mode 100644 docs/source/telegram.botcommandscopeallgroupchats.rst create mode 100644 docs/source/telegram.botcommandscopeallprivatechats.rst create mode 100644 docs/source/telegram.botcommandscopechat.rst create mode 100644 docs/source/telegram.botcommandscopechatadministrators.rst create mode 100644 docs/source/telegram.botcommandscopechatmember.rst create mode 100644 docs/source/telegram.botcommandscopedefault.rst create mode 100644 docs/source/telegram.botdescription.rst create mode 100644 docs/source/telegram.botname.rst create mode 100644 docs/source/telegram.botshortdescription.rst create mode 100644 docs/source/telegram.businessbotrights.rst create mode 100644 docs/source/telegram.businessconnection.rst create mode 100644 docs/source/telegram.businessintro.rst create mode 100644 docs/source/telegram.businesslocation.rst create mode 100644 docs/source/telegram.businessmessagesdeleted.rst create mode 100644 docs/source/telegram.businessopeninghours.rst create mode 100644 docs/source/telegram.businessopeninghoursinterval.rst create mode 100644 docs/source/telegram.callbackgame.rst create mode 100644 docs/source/telegram.callbackquery.rst create mode 100644 docs/source/telegram.chat.rst create mode 100644 docs/source/telegram.chatadministratorrights.rst create mode 100644 docs/source/telegram.chatbackground.rst create mode 100644 docs/source/telegram.chatboost.rst create mode 100644 docs/source/telegram.chatboostadded.rst create mode 100644 docs/source/telegram.chatboostremoved.rst create mode 100644 docs/source/telegram.chatboostsource.rst create mode 100644 docs/source/telegram.chatboostsourcegiftcode.rst create mode 100644 docs/source/telegram.chatboostsourcegiveaway.rst create mode 100644 docs/source/telegram.chatboostsourcepremium.rst create mode 100644 docs/source/telegram.chatboostupdated.rst create mode 100644 docs/source/telegram.chatfullinfo.rst create mode 100644 docs/source/telegram.chatinvitelink.rst create mode 100644 docs/source/telegram.chatjoinrequest.rst create mode 100644 docs/source/telegram.chatlocation.rst create mode 100644 docs/source/telegram.chatmember.rst create mode 100644 docs/source/telegram.chatmemberadministrator.rst create mode 100644 docs/source/telegram.chatmemberbanned.rst create mode 100644 docs/source/telegram.chatmemberleft.rst create mode 100644 docs/source/telegram.chatmembermember.rst create mode 100644 docs/source/telegram.chatmemberowner.rst create mode 100644 docs/source/telegram.chatmemberrestricted.rst create mode 100644 docs/source/telegram.chatmemberupdated.rst create mode 100644 docs/source/telegram.chatownerchanged.rst create mode 100644 docs/source/telegram.chatownerleft.rst create mode 100644 docs/source/telegram.chatpermissions.rst create mode 100644 docs/source/telegram.chatphoto.rst create mode 100644 docs/source/telegram.chatshared.rst create mode 100644 docs/source/telegram.checklist.rst create mode 100644 docs/source/telegram.checklisttask.rst create mode 100644 docs/source/telegram.checklisttasksadded.rst create mode 100644 docs/source/telegram.checklisttasksdone.rst create mode 100644 docs/source/telegram.choseninlineresult.rst create mode 100644 docs/source/telegram.contact.rst create mode 100644 docs/source/telegram.copytextbutton.rst create mode 100644 docs/source/telegram.credentials.rst create mode 100644 docs/source/telegram.datacredentials.rst create mode 100644 docs/source/telegram.dice.rst create mode 100644 docs/source/telegram.directmessagepricechanged.rst create mode 100644 docs/source/telegram.directmessagestopic.rst create mode 100644 docs/source/telegram.document.rst create mode 100644 docs/source/telegram.encryptedcredentials.rst create mode 100644 docs/source/telegram.encryptedpassportelement.rst create mode 100644 docs/source/telegram.ext.aioratelimiter.rst create mode 100644 docs/source/telegram.ext.application.rst create mode 100644 docs/source/telegram.ext.applicationbuilder.rst create mode 100644 docs/source/telegram.ext.applicationhandlerstop.rst create mode 100644 docs/source/telegram.ext.basehandler.rst create mode 100644 docs/source/telegram.ext.basepersistence.rst create mode 100644 docs/source/telegram.ext.baseratelimiter.rst create mode 100644 docs/source/telegram.ext.baseupdateprocessor.rst create mode 100644 docs/source/telegram.ext.businessconnectionhandler.rst create mode 100644 docs/source/telegram.ext.businessmessagesdeletedhandler.rst create mode 100644 docs/source/telegram.ext.callbackcontext.rst create mode 100644 docs/source/telegram.ext.callbackdatacache.rst create mode 100644 docs/source/telegram.ext.callbackqueryhandler.rst create mode 100644 docs/source/telegram.ext.chatboosthandler.rst create mode 100644 docs/source/telegram.ext.chatjoinrequesthandler.rst create mode 100644 docs/source/telegram.ext.chatmemberhandler.rst create mode 100644 docs/source/telegram.ext.choseninlineresulthandler.rst create mode 100644 docs/source/telegram.ext.commandhandler.rst create mode 100644 docs/source/telegram.ext.contexttypes.rst create mode 100644 docs/source/telegram.ext.conversationhandler.rst create mode 100644 docs/source/telegram.ext.defaults.rst create mode 100644 docs/source/telegram.ext.dictpersistence.rst create mode 100644 docs/source/telegram.ext.extbot.rst create mode 100644 docs/source/telegram.ext.inlinequeryhandler.rst create mode 100644 docs/source/telegram.ext.invalidcallbackdata.rst create mode 100644 docs/source/telegram.ext.job.rst create mode 100644 docs/source/telegram.ext.jobqueue.rst create mode 100644 docs/source/telegram.ext.managedbotupdatedhandler.rst create mode 100644 docs/source/telegram.ext.messagehandler.rst create mode 100644 docs/source/telegram.ext.messagereactionhandler.rst create mode 100644 docs/source/telegram.ext.paidmediapurchasedhandler.rst create mode 100644 docs/source/telegram.ext.persistenceinput.rst create mode 100644 docs/source/telegram.ext.picklepersistence.rst create mode 100644 docs/source/telegram.ext.pollanswerhandler.rst create mode 100644 docs/source/telegram.ext.pollhandler.rst create mode 100644 docs/source/telegram.ext.precheckoutqueryhandler.rst create mode 100644 docs/source/telegram.ext.prefixhandler.rst create mode 100644 docs/source/telegram.ext.shippingqueryhandler.rst create mode 100644 docs/source/telegram.ext.simpleupdateprocessor.rst create mode 100644 docs/source/telegram.ext.stringcommandhandler.rst create mode 100644 docs/source/telegram.ext.stringregexhandler.rst create mode 100644 docs/source/telegram.ext.typehandler.rst create mode 100644 docs/source/telegram.ext.updater.rst create mode 100644 docs/source/telegram.externalreplyinfo.rst create mode 100644 docs/source/telegram.file.rst create mode 100644 docs/source/telegram.filecredentials.rst create mode 100644 docs/source/telegram.forcereply.rst create mode 100644 docs/source/telegram.forumtopic.rst create mode 100644 docs/source/telegram.forumtopicclosed.rst create mode 100644 docs/source/telegram.forumtopiccreated.rst create mode 100644 docs/source/telegram.forumtopicedited.rst create mode 100644 docs/source/telegram.forumtopicreopened.rst create mode 100644 docs/source/telegram.game.rst create mode 100644 docs/source/telegram.gamehighscore.rst create mode 100644 docs/source/telegram.generalforumtopichidden.rst create mode 100644 docs/source/telegram.generalforumtopicunhidden.rst create mode 100644 docs/source/telegram.gift.rst create mode 100644 docs/source/telegram.giftbackground.rst create mode 100644 docs/source/telegram.giftinfo.rst create mode 100644 docs/source/telegram.gifts.rst create mode 100644 docs/source/telegram.giveaway.rst create mode 100644 docs/source/telegram.giveawaycompleted.rst create mode 100644 docs/source/telegram.giveawaycreated.rst create mode 100644 docs/source/telegram.giveawaywinners.rst create mode 100644 docs/source/telegram.iddocumentdata.rst create mode 100644 docs/source/telegram.inaccessiblemessage.rst create mode 100644 docs/source/telegram.inlinekeyboardbutton.rst create mode 100644 docs/source/telegram.inlinekeyboardmarkup.rst create mode 100644 docs/source/telegram.inlinequery.rst create mode 100644 docs/source/telegram.inlinequeryresult.rst create mode 100644 docs/source/telegram.inlinequeryresultarticle.rst create mode 100644 docs/source/telegram.inlinequeryresultaudio.rst create mode 100644 docs/source/telegram.inlinequeryresultcachedaudio.rst create mode 100644 docs/source/telegram.inlinequeryresultcacheddocument.rst create mode 100644 docs/source/telegram.inlinequeryresultcachedgif.rst create mode 100644 docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst create mode 100644 docs/source/telegram.inlinequeryresultcachedphoto.rst create mode 100644 docs/source/telegram.inlinequeryresultcachedsticker.rst create mode 100644 docs/source/telegram.inlinequeryresultcachedvideo.rst create mode 100644 docs/source/telegram.inlinequeryresultcachedvoice.rst create mode 100644 docs/source/telegram.inlinequeryresultcontact.rst create mode 100644 docs/source/telegram.inlinequeryresultdocument.rst create mode 100644 docs/source/telegram.inlinequeryresultgame.rst create mode 100644 docs/source/telegram.inlinequeryresultgif.rst create mode 100644 docs/source/telegram.inlinequeryresultlocation.rst create mode 100644 docs/source/telegram.inlinequeryresultmpeg4gif.rst create mode 100644 docs/source/telegram.inlinequeryresultphoto.rst create mode 100644 docs/source/telegram.inlinequeryresultsbutton.rst create mode 100644 docs/source/telegram.inlinequeryresultvenue.rst create mode 100644 docs/source/telegram.inlinequeryresultvideo.rst create mode 100644 docs/source/telegram.inlinequeryresultvoice.rst create mode 100644 docs/source/telegram.inputchecklist.rst create mode 100644 docs/source/telegram.inputchecklisttask.rst create mode 100644 docs/source/telegram.inputcontactmessagecontent.rst create mode 100644 docs/source/telegram.inputfile.rst create mode 100644 docs/source/telegram.inputinvoicemessagecontent.rst create mode 100644 docs/source/telegram.inputlocationmessagecontent.rst create mode 100644 docs/source/telegram.inputmedia.rst create mode 100644 docs/source/telegram.inputmediaanimation.rst create mode 100644 docs/source/telegram.inputmediaaudio.rst create mode 100644 docs/source/telegram.inputmediadocument.rst create mode 100644 docs/source/telegram.inputmedialivephoto.rst create mode 100644 docs/source/telegram.inputmedialocation.rst create mode 100644 docs/source/telegram.inputmediaphoto.rst create mode 100644 docs/source/telegram.inputmediasticker.rst create mode 100644 docs/source/telegram.inputmediavenue.rst create mode 100644 docs/source/telegram.inputmediavideo.rst create mode 100644 docs/source/telegram.inputmessagecontent.rst create mode 100644 docs/source/telegram.inputpaidmedia.rst create mode 100644 docs/source/telegram.inputpaidmedialivephoto.rst create mode 100644 docs/source/telegram.inputpaidmediaphoto.rst create mode 100644 docs/source/telegram.inputpaidmediavideo.rst create mode 100644 docs/source/telegram.inputpolloption.rst create mode 100644 docs/source/telegram.inputprofilephoto.rst create mode 100644 docs/source/telegram.inputprofilephotoanimated.rst create mode 100644 docs/source/telegram.inputprofilephotostatic.rst create mode 100644 docs/source/telegram.inputsticker.rst create mode 100644 docs/source/telegram.inputstorycontent.rst create mode 100644 docs/source/telegram.inputstorycontentphoto.rst create mode 100644 docs/source/telegram.inputstorycontentvideo.rst create mode 100644 docs/source/telegram.inputtextmessagecontent.rst create mode 100644 docs/source/telegram.inputvenuemessagecontent.rst create mode 100644 docs/source/telegram.invoice.rst create mode 100644 docs/source/telegram.keyboardbutton.rst create mode 100644 docs/source/telegram.keyboardbuttonpolltype.rst create mode 100644 docs/source/telegram.keyboardbuttonrequestchat.rst create mode 100644 docs/source/telegram.keyboardbuttonrequestmanagedbot.rst create mode 100644 docs/source/telegram.keyboardbuttonrequestusers.rst create mode 100644 docs/source/telegram.labeledprice.rst create mode 100644 docs/source/telegram.linkpreviewoptions.rst create mode 100644 docs/source/telegram.livephoto.rst create mode 100644 docs/source/telegram.location.rst create mode 100644 docs/source/telegram.locationaddress.rst create mode 100644 docs/source/telegram.loginurl.rst create mode 100644 docs/source/telegram.managedbotcreated.rst create mode 100644 docs/source/telegram.managedbotupdated.rst create mode 100644 docs/source/telegram.maskposition.rst create mode 100644 docs/source/telegram.maybeinaccessiblemessage.rst create mode 100644 docs/source/telegram.menubutton.rst create mode 100644 docs/source/telegram.menubuttoncommands.rst create mode 100644 docs/source/telegram.menubuttondefault.rst create mode 100644 docs/source/telegram.menubuttonwebapp.rst create mode 100644 docs/source/telegram.message.rst create mode 100644 docs/source/telegram.messageautodeletetimerchanged.rst create mode 100644 docs/source/telegram.messageentity.rst create mode 100644 docs/source/telegram.messageid.rst create mode 100644 docs/source/telegram.messageorigin.rst create mode 100644 docs/source/telegram.messageoriginchannel.rst create mode 100644 docs/source/telegram.messageoriginchat.rst create mode 100644 docs/source/telegram.messageoriginhiddenuser.rst create mode 100644 docs/source/telegram.messageoriginuser.rst create mode 100644 docs/source/telegram.messagereactioncountupdated.rst create mode 100644 docs/source/telegram.messagereactionupdated.rst create mode 100644 docs/source/telegram.orderinfo.rst create mode 100644 docs/source/telegram.ownedgift.rst create mode 100644 docs/source/telegram.ownedgiftregular.rst create mode 100644 docs/source/telegram.ownedgifts.rst create mode 100644 docs/source/telegram.ownedgiftunique.rst create mode 100644 docs/source/telegram.paidmedia.rst create mode 100644 docs/source/telegram.paidmediainfo.rst create mode 100644 docs/source/telegram.paidmedialivephoto.rst create mode 100644 docs/source/telegram.paidmediaphoto.rst create mode 100644 docs/source/telegram.paidmediapreview.rst create mode 100644 docs/source/telegram.paidmediapurchased.rst create mode 100644 docs/source/telegram.paidmediavideo.rst create mode 100644 docs/source/telegram.paidmessagepricechanged.rst create mode 100644 docs/source/telegram.passportdata.rst create mode 100644 docs/source/telegram.passportelementerror.rst create mode 100644 docs/source/telegram.passportelementerrordatafield.rst create mode 100644 docs/source/telegram.passportelementerrorfile.rst create mode 100644 docs/source/telegram.passportelementerrorfiles.rst create mode 100644 docs/source/telegram.passportelementerrorfrontside.rst create mode 100644 docs/source/telegram.passportelementerrorreverseside.rst create mode 100644 docs/source/telegram.passportelementerrorselfie.rst create mode 100644 docs/source/telegram.passportelementerrortranslationfile.rst create mode 100644 docs/source/telegram.passportelementerrortranslationfiles.rst create mode 100644 docs/source/telegram.passportelementerrorunspecified.rst create mode 100644 docs/source/telegram.passportfile.rst create mode 100644 docs/source/telegram.personaldetails.rst create mode 100644 docs/source/telegram.photosize.rst create mode 100644 docs/source/telegram.poll.rst create mode 100644 docs/source/telegram.pollanswer.rst create mode 100644 docs/source/telegram.pollmedia.rst create mode 100644 docs/source/telegram.polloption.rst create mode 100644 docs/source/telegram.polloptionadded.rst create mode 100644 docs/source/telegram.polloptiondeleted.rst create mode 100644 docs/source/telegram.precheckoutquery.rst create mode 100644 docs/source/telegram.preparedinlinemessage.rst create mode 100644 docs/source/telegram.preparedkeyboardbutton.rst create mode 100644 docs/source/telegram.proximityalerttriggered.rst create mode 100644 docs/source/telegram.reactioncount.rst create mode 100644 docs/source/telegram.reactiontype.rst create mode 100644 docs/source/telegram.reactiontypecustomemoji.rst create mode 100644 docs/source/telegram.reactiontypeemoji.rst create mode 100644 docs/source/telegram.reactiontypepaid.rst create mode 100644 docs/source/telegram.refundedpayment.rst create mode 100644 docs/source/telegram.replykeyboardmarkup.rst create mode 100644 docs/source/telegram.replykeyboardremove.rst create mode 100644 docs/source/telegram.replyparameters.rst create mode 100644 docs/source/telegram.request.baserequest.rst create mode 100644 docs/source/telegram.request.httpxrequest.rst create mode 100644 docs/source/telegram.request.requestdata.rst create mode 100644 docs/source/telegram.residentialaddress.rst create mode 100644 docs/source/telegram.revenuewithdrawalstate.rst create mode 100644 docs/source/telegram.revenuewithdrawalstatefailed.rst create mode 100644 docs/source/telegram.revenuewithdrawalstatepending.rst create mode 100644 docs/source/telegram.revenuewithdrawalstatesucceeded.rst create mode 100644 docs/source/telegram.securedata.rst create mode 100644 docs/source/telegram.securevalue.rst create mode 100644 docs/source/telegram.sentguestmessage.rst create mode 100644 docs/source/telegram.sentwebappmessage.rst create mode 100644 docs/source/telegram.shareduser.rst create mode 100644 docs/source/telegram.shippingaddress.rst create mode 100644 docs/source/telegram.shippingoption.rst create mode 100644 docs/source/telegram.shippingquery.rst create mode 100644 docs/source/telegram.staramount.rst create mode 100644 docs/source/telegram.startransaction.rst create mode 100644 docs/source/telegram.startransactions.rst create mode 100644 docs/source/telegram.sticker.rst create mode 100644 docs/source/telegram.stickerset.rst create mode 100644 docs/source/telegram.story.rst create mode 100644 docs/source/telegram.storyarea.rst create mode 100644 docs/source/telegram.storyareaposition.rst create mode 100644 docs/source/telegram.storyareatype.rst create mode 100644 docs/source/telegram.storyareatypelink.rst create mode 100644 docs/source/telegram.storyareatypelocation.rst create mode 100644 docs/source/telegram.storyareatypesuggestedreaction.rst create mode 100644 docs/source/telegram.storyareatypeuniquegift.rst create mode 100644 docs/source/telegram.storyareatypeweather.rst create mode 100644 docs/source/telegram.successfulpayment.rst create mode 100644 docs/source/telegram.suggestedpostapprovalfailed.rst create mode 100644 docs/source/telegram.suggestedpostapproved.rst create mode 100644 docs/source/telegram.suggestedpostdeclined.rst create mode 100644 docs/source/telegram.suggestedpostinfo.rst create mode 100644 docs/source/telegram.suggestedpostpaid.rst create mode 100644 docs/source/telegram.suggestedpostparameters.rst create mode 100644 docs/source/telegram.suggestedpostprice.rst create mode 100644 docs/source/telegram.suggestedpostrefunded.rst create mode 100644 docs/source/telegram.switchinlinequerychosenchat.rst create mode 100644 docs/source/telegram.telegramobject.rst create mode 100644 docs/source/telegram.textquote.rst create mode 100644 docs/source/telegram.transactionpartner.rst create mode 100644 docs/source/telegram.transactionpartneraffiliateprogram.rst create mode 100644 docs/source/telegram.transactionpartnerchat.rst create mode 100644 docs/source/telegram.transactionpartnerfragment.rst create mode 100644 docs/source/telegram.transactionpartnerother.rst create mode 100644 docs/source/telegram.transactionpartnertelegramads.rst create mode 100644 docs/source/telegram.transactionpartnertelegramapi.rst create mode 100644 docs/source/telegram.transactionpartneruser.rst create mode 100644 docs/source/telegram.uniquegift.rst create mode 100644 docs/source/telegram.uniquegiftbackdrop.rst create mode 100644 docs/source/telegram.uniquegiftbackdropcolors.rst create mode 100644 docs/source/telegram.uniquegiftcolors.rst create mode 100644 docs/source/telegram.uniquegiftinfo.rst create mode 100644 docs/source/telegram.uniquegiftmodel.rst create mode 100644 docs/source/telegram.uniquegiftsymbol.rst create mode 100644 docs/source/telegram.update.rst create mode 100644 docs/source/telegram.user.rst create mode 100644 docs/source/telegram.userchatboosts.rst create mode 100644 docs/source/telegram.userprofileaudios.rst create mode 100644 docs/source/telegram.userprofilephotos.rst create mode 100644 docs/source/telegram.userrating.rst create mode 100644 docs/source/telegram.usersshared.rst create mode 100644 docs/source/telegram.venue.rst create mode 100644 docs/source/telegram.video.rst create mode 100644 docs/source/telegram.videochatended.rst create mode 100644 docs/source/telegram.videochatparticipantsinvited.rst create mode 100644 docs/source/telegram.videochatscheduled.rst create mode 100644 docs/source/telegram.videochatstarted.rst create mode 100644 docs/source/telegram.videonote.rst create mode 100644 docs/source/telegram.videoquality.rst create mode 100644 docs/source/telegram.voice.rst create mode 100644 docs/source/telegram.webappdata.rst create mode 100644 docs/source/telegram.webappinfo.rst create mode 100644 docs/source/telegram.webhookinfo.rst create mode 100644 docs/source/telegram.writeaccessallowed.rst create mode 100644 docs/source/telegram/chat.rst create mode 100644 docs/source/telegram/chatfullinfo.rst create mode 100644 docs/source/telegram/constants.rst create mode 100644 docs/source/telegram/error.rst create mode 100644 docs/source/telegram/ext/applicationbuilder.rst create mode 100644 docs/source/telegram/ext/callbackcontext.rst create mode 100644 docs/source/telegram/ext/extbot.rst create mode 100644 docs/source/telegram/ext/filters.rst create mode 100644 docs/source/telegram/ext/index.rst create mode 100644 docs/source/telegram/ext/persistenceinput.rst create mode 100644 docs/source/telegram/helpers.rst create mode 100644 docs/source/telegram/index.rst create mode 100644 docs/source/telegram/inputpollmedia.rst create mode 100644 docs/source/telegram/inputpolloptionmedia.rst create mode 100644 docs/source/telegram/request/index.rst create mode 100644 docs/source/telegram/warnings.rst create mode 100644 docs/source/telegram_auxil/index.rst diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index 91a0d7337ec..cb140409134 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -231,16 +231,6 @@ or, if you don't have ``make`` available (e.g. on Windows): Once the process terminates, you can view the built documentation by opening ``docs/build/html/index.html`` with a browser. -- Reference pages for public objects exported in the ``__all__`` of ``telegram``, ``telegram.ext`` and - ``telegram.request`` are generated automatically during the Sphinx build. Do not add a - ``docs/source/telegram..rst`` file for a normal class. New objects are added to their - package's default toctree automatically. To list an object in one of the specialized sections - instead, add its lower-case document name to the corresponding ``*-tree.rst`` file. - An object that cannot be rendered correctly by the shared template may keep a manual RST page. - Such a page must start with the manual-page marker defined in ``docs/auxil/api_docs.py`` and be - explicitly unignored in ``.gitignore``. Rare custom autodoc options are also configured in - ``docs/auxil/api_docs.py``. - - Add ``.. versionadded:: NEXT.VERSION``, ``.. versionchanged:: NEXT.VERSION`` or ``.. deprecated:: NEXT.VERSION`` to the associated documentation of your changes, depending on what kind of change you made. This only applies if the change you made is visible to an end user. The directives should be added to class/method descriptions if their general behaviour changed and to the description of all arguments & attributes that changed. For a new class, put ``.. versionadded:: NEXT.VERSION`` in the class docstring. diff --git a/.gitignore b/.gitignore index cc800e8715c..01c2cfda73f 100644 --- a/.gitignore +++ b/.gitignore @@ -64,29 +64,6 @@ coverage.xml # Sphinx documentation docs/_build/ -# Transient API pages generated by docs.auxil.api_docs -/docs/source/telegram.*.rst -!/docs/source/telegram.rst -!/docs/source/telegram.at-tree.rst -!/docs/source/telegram.constants.rst -!/docs/source/telegram.error.rst -!/docs/source/telegram.ext.acd-tree.rst -!/docs/source/telegram.ext.filters.rst -!/docs/source/telegram.ext.handlers-tree.rst -!/docs/source/telegram.ext.persistence-tree.rst -!/docs/source/telegram.ext.rate-limiting-tree.rst -!/docs/source/telegram.ext.rst -!/docs/source/telegram.games-tree.rst -!/docs/source/telegram.helpers.rst -!/docs/source/telegram.inline-tree.rst -!/docs/source/telegram.passport-tree.rst -!/docs/source/telegram.payments-tree.rst -!/docs/source/telegram.request.rst -!/docs/source/telegram.stickers-tree.rst -!/docs/source/telegram.warnings.rst -!/docs/source/telegram.inputpollmedia.rst -!/docs/source/telegram.inputpolloptionmedia.rst - # PyBuilder target/ .idea/ diff --git a/docs/auxil/api_docs.py b/docs/auxil/api_docs.py index 85b1f7993bc..10af478b023 100644 --- a/docs/auxil/api_docs.py +++ b/docs/auxil/api_docs.py @@ -15,328 +15,443 @@ # # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. -"""Generate the public API reference from PTB's ``__all__`` exports. +"""Generate PTB's API reference from its public exports. -Sphinx's autosummary extension can generate one source document per object, but it normally expects -the object list to be maintained in an RST file. This extension builds that list from PTB's public -exports instead and removes the generated sources when the build finishes. +Sphinx discovers documents from physical source files before it reads their toctrees. Autosummary +can create those files, but normally needs a maintained RST list of objects. This extension instead +collects objects from PTB's ``__all__`` exports during ``builder-inited`` and writes the required +sources before discovery. During ``source-read``, it adds the current navigation in memory, so RST +files never contain generated class lists. + +Maintained sources live in module-shaped directories for readability. Small generated wrappers +preserve the historic dotted document names and URLs. Generated files remain on disk, and are only +rewritten when their content changes, so Sphinx's normal mtime cache remains effective. Relevant Sphinx documentation: * Autosummary: https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html -* Custom templates: https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html#customizing-templates -* Sphinx events: https://www.sphinx-doc.org/en/master/extdev/event_callbacks.html +* Build events: https://www.sphinx-doc.org/en/master/extdev/event_callbacks.html """ -from __future__ import annotations - import tempfile -from collections import Counter -from importlib import import_module +from collections.abc import Mapping, Sequence from pathlib import Path from types import ModuleType -from typing import TYPE_CHECKING, Final +from typing import Final, NamedTuple +from sphinx.application import Sphinx from sphinx.errors import ExtensionError from sphinx.ext.autosummary.generate import generate_autosummary_docs -from sphinx.util import logging - -if TYPE_CHECKING: - from collections.abc import Iterable, Sequence - - from sphinx.application import Sphinx - - -LOGGER = logging.getLogger(__name__) - -API_MODULES: Final = ("telegram", "telegram.ext", "telegram.request") -GENERATED_MARKER: Final = ( - ".. This file is generated by docs.auxil.api_docs. Do not edit it directly." -) -MANUAL_MARKER: Final = ( - ".. This API page is maintained manually and is not generated by docs.auxil.api_docs." -) - -# Most API objects belong in the package's default, alphabetically sorted toctree. Objects listed -# in these hand-written topic trees are subtracted from that default tree to avoid duplicate -# navigation entries. -TOP_LEVEL_SPECIALIZED_TREES: Final = ( - "telegram.inline-tree", - "telegram.payments-tree", - "telegram.games-tree", - "telegram.passport-tree", - "telegram.stickers-tree", -) -EXT_SPECIALIZED_TREES: Final = ( - "telegram.ext.handlers-tree", - "telegram.ext.persistence-tree", - "telegram.ext.acd-tree", - "telegram.ext.rate-limiting-tree", -) - -# These markers keep the small package-level RST files readable. During ``source-read`` they are -# replaced in memory with toctrees built from the current public exports. -TOCTREE_MARKERS: Final = { - "telegram.at-tree": ".. ptb-api-toctree:: available-types", - "telegram.ext": ".. ptb-api-toctree:: ext", - "telegram.request": ".. ptb-api-toctree:: request", -} +from sphinx.util.typing import ExtensionMetadata + +import telegram +import telegram.ext +import telegram.request + + +class ApiCategory(NamedTuple): + """Describe one topic page and the internal modules whose objects belong on it.""" + + title: str + module_prefixes: tuple[str, ...] + -# The old per-object RST files were almost all identical. Only genuine rendering differences live -# here; everything else receives the default options from the autosummary template. -DEFAULT_AUTODOC_OPTION_BLOCK: Final = " :members:\n :show-inheritance:" -AUTODOC_OPTION_BLOCKS: Final = { - "telegram.Chat": ( - " :members:\n :show-inheritance:\n :inherited-members: TelegramObject, object" +class MaintainedFragment(NamedTuple): + """Connect a nested maintained source to its generated dotted-name wrapper.""" + + wrapper_path: Path + relative_path: Path + + +GENERATED_MARKER: Final[str] = ".. Autogenerated page: True" +MAINTAINED_MARKER: Final[str] = ".. Autogenerated page: False" +FRAGMENT_DIRECTORIES: Final[tuple[str, ...]] = ("examples", "telegram", "telegram_auxil") +API_MODULES: Final[tuple[ModuleType, ...]] = (telegram, telegram.ext, telegram.request) + +# The key is the Sphinx document name. The value supplies its title and the internal module +# prefixes used to recognize its public objects; new objects in those modules need no docs edit. +API_CATEGORIES: Final[dict[str, ApiCategory]] = { + "telegram.stickers-tree": ApiCategory( + title="Stickers", + module_prefixes=("telegram._files.inputsticker", "telegram._files.sticker"), + ), + "telegram.inline-tree": ApiCategory( + title="Inline Mode", + module_prefixes=( + "telegram._choseninlineresult", + "telegram._inline.inlinequery", + "telegram._inline.input", + "telegram._inline.preparedinlinemessage", + ), + ), + "telegram.payments-tree": ApiCategory( + title="Payments", module_prefixes=("telegram._payment.",) + ), + "telegram.games-tree": ApiCategory(title="Games", module_prefixes=("telegram._games.",)), + "telegram.passport-tree": ApiCategory( + title="Passport", module_prefixes=("telegram._passport.",) + ), + "telegram.ext.handlers-tree": ApiCategory( + title="Handlers", + module_prefixes=("telegram.ext._handlers.", "telegram.ext.filters"), ), - "telegram.ChatFullInfo": ( - " :members:\n :show-inheritance:\n :inherited-members: TelegramObject, object" + "telegram.ext.persistence-tree": ApiCategory( + title="Persistence", + module_prefixes=( + "telegram.ext._basepersistence", + "telegram.ext._dictpersistence", + "telegram.ext._picklepersistence", + ), ), - "telegram.ext.ApplicationBuilder": " :members:", - "telegram.ext.CallbackContext": " :members:", - "telegram.ext.ExtBot": ( - " :show-inheritance:\n" - " :members: insert_callback_data, defaults, rate_limiter, initialize, shutdown, " - "callback_data_cache" + "telegram.ext.acd-tree": ApiCategory( + title="Arbitrary Callback Data", + module_prefixes=("telegram.ext._callbackdatacache",), + ), + "telegram.ext.rate-limiting-tree": ApiCategory( + title="Rate Limiting", + module_prefixes=("telegram.ext._aioratelimiter", "telegram.ext._baseratelimiter"), ), - "telegram.ext.PersistenceInput": " :show-inheritance:", } -def _api_object_names() -> tuple[str, ...]: - """Return the public API objects that should have their own documentation page. +def _build_api_objects() -> dict[str, str]: + """Map every public import name to the internal module that defines its object. - ``__all__`` is already PTB's source of truth for the supported public API. Reusing it here - means exporting a new class is enough to give it a reference page. + ``__all__`` is PTB's source of truth for supported imports. The defining module is retained + only to assign each public name to the appropriate topic page without maintaining class lists. """ - names = [] - for module_name in API_MODULES: - module = import_module(module_name) - for name in module.__all__: - obj = getattr(module, name) - if not name.startswith("_") and not isinstance(obj, ModuleType): - names.append(f"{module_name}.{name}") + api_objects: dict[str, str] = {} + + # Read the three supported public namespaces and ignore private version metadata. + for api_module in API_MODULES: + for export_name in api_module.__all__: + if export_name.startswith("_"): + continue - return tuple(sorted(names, key=str.casefold)) + exported_object: object = getattr(api_module, export_name) + defining_module: str = getattr( + exported_object, "__module__", getattr(exported_object, "__name__", "") + ) + public_name: str = f"{api_module.__name__}.{export_name}" + api_objects[public_name] = defining_module + # Stable case-insensitive ordering makes every generated menu deterministic. + ordered_items: list[tuple[str, str]] = sorted( + api_objects.items(), key=lambda item: item[0].casefold() + ) + return dict(ordered_items) -def _docname(object_name: str) -> str: - """Return the historic, lower-case Sphinx document name for an API object. - ``autosummary_filename_map`` supports this explicit mapping: - https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html#confval-autosummary_filename_map +def _build_api_trees(api_objects: Mapping[str, str]) -> dict[str, tuple[str, ...]]: + """Build the navigation trees from topic membership and package fallbacks. - Keeping the old names preserves URLs such as ``telegram.chatmember.html``. + Topic pages claim their objects first. Everything left over is placed in Available Types, + ``telegram.ext``, ``telegram.request``, or Auxiliary Modules, preventing duplicate entries. """ - return object_name.lower() + api_trees: dict[str, tuple[str, ...]] = {} + + # This set prevents an object claimed by a topic page from also appearing in a fallback tree. + categorized_objects: set[str] = set() + telegram_category_pages: list[str] = [] + ext_category_pages: list[str] = [] + + # Match public objects to topic pages through their internal module boundaries. + for docname, category in API_CATEGORIES.items(): + category_objects: list[str] = [ + object_name + for object_name, defining_module in api_objects.items() + if defining_module.startswith(category.module_prefixes) + ] + api_trees[docname] = tuple(category_objects) + categorized_objects.update(category_objects) + + if docname.startswith("telegram.ext."): + ext_category_pages.append(docname) + else: + telegram_category_pages.append(docname) + + # These lists form the general package sections after specialized topics have been removed. + available_types: list[str] = [] # Top-level ``telegram`` classes except Bot. + ext_objects: list[str] = [] # Ungrouped ``telegram.ext`` exports. + request_objects: list[str] = [] # Public request implementations. + auxiliary_objects: list[str] = [] # Top-level modules and helper functions. + + for object_name in api_objects: + if object_name.startswith("telegram.ext."): + if object_name not in categorized_objects: + ext_objects.append(object_name) + continue + + if object_name.startswith("telegram.request."): + request_objects.append(object_name) + continue + + short_name: str = object_name.rpartition(".")[2] + if short_name[:1].isupper(): + if object_name != "telegram.Bot" and object_name not in categorized_objects: + available_types.append(object_name) + else: + auxiliary_objects.append(object_name) + # Package trees contain their ordinary entries followed by generated topic pages. + api_trees["telegram"] = ("telegram.Bot", "telegram.at-tree", *telegram_category_pages) + api_trees["telegram.at-tree"] = tuple(available_types) + api_trees["telegram.ext"] = (*ext_objects, *ext_category_pages) + api_trees["telegram.request"] = tuple(request_objects) + api_trees["telegram_auxil"] = tuple(auxiliary_objects) + return api_trees -def _generated_path(source_dir: Path, object_name: str) -> Path: - return source_dir / f"{_docname(object_name)}.rst" + +def _build_api_tree_dependencies() -> tuple[Path, ...]: + """Return files whose changes must invalidate an injected navigation tree. + + The generated toctree text is not present in the physical RST file, so Sphinx cannot infer + these dependencies itself. Tracking the extension and public ``__init__`` files fixes that. + """ + dependencies: list[Path] = [ + Path(api_module.__file__) for api_module in API_MODULES if api_module.__file__ is not None + ] + [Path(__file__)] + return tuple(dependencies) + + +API_OBJECTS: Final[dict[str, str]] = _build_api_objects() +API_TREES: Final[dict[str, tuple[str, ...]]] = _build_api_trees(API_OBJECTS) +API_TREE_DEPENDENCIES: Final[tuple[Path, ...]] = _build_api_tree_dependencies() def _has_marker(path: Path, marker: str) -> bool: + """Return whether the first line marks a page as generated or maintained. + + Ownership markers let cleanup delete obsolete generated files while protecting every file that + a maintainer may edit. + """ if not path.is_file(): return False - # Sphinx's default source encoding is ``utf-8-sig``, so autosummary output carries a BOM. + # Sphinx defaults to utf-8-sig, so autosummary output may begin with a byte-order mark. with path.open(encoding="utf-8-sig") as file: - return file.readline().rstrip() == marker + first_line: str = file.readline().rstrip() + return first_line == marker -def _is_generated(path: Path) -> bool: - return _has_marker(path, GENERATED_MARKER) +def _write_generated(path: Path, content: str) -> None: + """Safely write one generated page without defeating Sphinx's mtime cache. + An existing maintained page is always an error. Identical generated content is left untouched, + so a repeated build does not make Sphinx parse the page again. + """ + generated_content: str = f"{GENERATED_MARKER}\n\n{content.rstrip()}\n" + + # Don't overwrite manually written pages: + if path.exists() and not _has_marker(path, GENERATED_MARKER): + raise ExtensionError(f"Refusing to overwrite maintained documentation page: {path}") -def _is_manual(path: Path) -> bool: - """Return whether *path* is an explicit hand-written override of a generated API page.""" - return _has_marker(path, MANUAL_MARKER) + # Preserve the existing mtime unless the generated source actually changed. + if not path.exists() or path.read_text(encoding="utf-8") != generated_content: + path.write_text(generated_content, encoding="utf-8") -def _remove_generated_pages(source_dir: Path) -> None: - """Remove only API pages carrying our generator marker. +def _toctree(entries: Sequence[str]) -> str: + """Render navigation text that ``source-read`` can append before RST parsing. - The marker check protects package pages, topic trees, and manual object-page overrides. + Entries are lower-cased because the compatibility sources and their historic document names + are lower-case, even though their public Python names retain normal capitalization. """ - for path in source_dir.glob("telegram.*.rst"): - if _is_generated(path): - path.unlink() - - -def _autosummary_manifest(object_names: Sequence[str]) -> str: - objects = "\n".join(f" {name}" for name in object_names) - return ( - ".. autosummary::\n" - " :toctree:\n" - " :template: ptb-object.rst\n" - " :signatures: none\n" - f"\n{objects}\n" - ) + lines: list[str] = [".. toctree::", " :titlesonly:", ""] + lines.extend(f" {entry.lower()}" for entry in entries) + return "\n".join(lines) -def _configure_autosummary(app: Sphinx, object_names: Sequence[str]) -> None: - filename_map = dict(app.config.autosummary_filename_map) - filename_map.update({name: _docname(name) for name in object_names}) - app.config.autosummary_filename_map = filename_map +def _configure_object_targets(app: Sphinx, source_dir: Path) -> dict[str, Path]: + """Configure autosummary's filenames and return each object's physical source path. - context = dict(app.config.autosummary_context) - context.update( - { - "ptb_autodoc_option_blocks": AUTODOC_OPTION_BLOCKS, - "ptb_default_autodoc_option_block": DEFAULT_AUTODOC_OPTION_BLOCK, - } - ) - app.config.autosummary_context = context + Autosummary normally derives filenames from case-sensitive Python names. Explicit mappings keep + URLs such as ``telegram.chatmember.html`` while still documenting ``telegram.ChatMember``. + """ + object_targets: dict[str, Path] = {} + filename_map: dict[str, str] = dict(app.config.autosummary_filename_map) + # Both mappings use the same dotted, lower-case document name. + for object_name in API_OBJECTS: + filename: str = object_name.lower() + object_targets[object_name] = source_dir / f"{filename}.rst" + filename_map[object_name] = filename -def _generate_api_pages(app: Sphinx) -> None: - """Create transient autosummary sources before Sphinx scans for documents. + app.config.autosummary_filename_map = filename_map + return object_targets - Autosummary still produces physical RST sources because Sphinx discovers documents by source - path. They are ignored by Git and deleted on both successful and failed builds, so they never - become files that maintainers need to review or update. + +def _discover_maintained_fragments(source_dir: Path) -> dict[str, MaintainedFragment]: + """Find maintained sources and describe the dotted wrappers they require. + + Devs work in directories such as ``telegram/ext``. Those directories are excluded from + Sphinx discovery; generated root-level wrappers include them under the historic dotted names. + Every discovered source must explicitly carry the False marker before it can be included. """ - source_dir = Path(app.srcdir) - # Clean up a previous build that was interrupted before ``build-finished`` could run. - _remove_generated_pages(source_dir) - - object_names = _api_object_names() - object_paths = {name: _generated_path(source_dir, name) for name in object_names} - manual_names = [name for name, path in object_paths.items() if _is_manual(path)] - generated_names = [name for name in object_names if name not in manual_names] - generated_paths = [object_paths[name] for name in generated_names] - - # A hand-written page must opt in with ``MANUAL_MARKER``. This prevents an untracked or stale - # file from silently taking precedence over the generated public API documentation. - conflicts = [path for path in object_paths.values() if path.exists() and not _is_manual(path)] - if conflicts: - formatted = "\n".join(f"* {path}" for path in conflicts) + fragments: dict[str, MaintainedFragment] = {} + unmarked_fragments: list[Path] = [] + + # Scan only the module-shaped directories owned by this extension. + for directory in FRAGMENT_DIRECTORIES: + directory_path: Path = source_dir / directory + fragment_paths: list[Path] = sorted(directory_path.rglob("*.rst")) + + for fragment_path in fragment_paths: + if not _has_marker(fragment_path, MAINTAINED_MARKER): + unmarked_fragments.append(fragment_path) + + relative_path: Path = fragment_path.relative_to(source_dir) + docname_parts: tuple[str, ...] = relative_path.with_suffix("").parts + if docname_parts[-1] == "index": + docname_parts = docname_parts[:-1] + + docname: str = ".".join(docname_parts) + wrapper_path: Path = source_dir / f"{docname}.rst" + fragments[docname] = MaintainedFragment(wrapper_path, relative_path) + + # Failing once with every offending path makes ownership errors straightforward to repair. + if unmarked_fragments: + formatted_paths: str = "\n".join(f"* {path}" for path in unmarked_fragments) raise ExtensionError( - "Refusing to overwrite API documentation pages without the manual-page marker:\n" - f"{formatted}" + f"Maintained documentation pages need the False marker:\n{formatted_paths}" ) - _configure_autosummary(app, object_names) - - try: - with tempfile.TemporaryDirectory(prefix="ptb-api-docs-") as temp_dir: - manifest = Path(temp_dir) / "api.rst" - manifest.write_text(_autosummary_manifest(generated_names), encoding="utf-8") - generate_autosummary_docs( - [str(manifest)], - output_dir=source_dir, - app=app, - overwrite=True, - encoding=app.config.source_encoding, - ) - except Exception: - _remove_generated_pages(source_dir) - raise - - missing = [path for path in generated_paths if not _is_generated(path)] - if missing: - formatted = "\n".join(f"* {path}" for path in missing) - _remove_generated_pages(source_dir) - raise ExtensionError(f"Autosummary did not generate the expected API pages:\n{formatted}") - - LOGGER.info( - "generated %d transient API documentation pages; using %d manual overrides", - len(generated_paths), - len(manual_names), - ) + return fragments -def _toctree_entries(path: Path) -> list[str]: - entries = [] - in_toctree = False +def _synchronize_compatibility_pages( + source_dir: Path, + object_targets: Mapping[str, Path], + fragments: Mapping[str, MaintainedFragment], +) -> None: + """Synchronize generated wrappers and topic shells before Sphinx scans the source tree. - for line in path.read_text(encoding="utf-8").splitlines(): - if line.startswith(".. toctree::"): - in_toctree = True - continue - if not in_toctree: - continue - if not line.strip() or line.startswith(" :"): - continue - if line.startswith(" "): - entries.append(line.strip().removesuffix(".rst")) - continue - in_toctree = False - - return entries + Wrapper pages expose nested maintained files under dotted names. Topic shells provide physical + documents for navigation injected later. Obsolete generated pages are removed only when their + marker proves that this extension owns them. + """ + # Build the complete set of generated paths that are still valid in this run. + expected_targets: set[Path] = set(object_targets.values()) + expected_targets.update(fragment.wrapper_path for fragment in fragments.values()) + expected_targets.add(source_dir / "telegram.at-tree.rst") + expected_targets.update(source_dir / f"{docname}.rst" for docname in API_CATEGORIES) + + # Remove pages for exports or maintained fragments that no longer exist. + for generated_path in source_dir.glob("*.rst"): + if generated_path not in expected_targets and _has_marker( + generated_path, GENERATED_MARKER + ): + generated_path.unlink() + + # Each nested maintained source receives a tiny include wrapper with its historic docname. + for fragment in fragments.values(): + include_directive: str = f".. include:: {fragment.relative_path.as_posix()}" + _write_generated(fragment.wrapper_path, include_directive) + + # Topic documents need only a heading; their object lists are injected during source-read. + _write_generated(source_dir / "telegram.at-tree.rst", "Available Types\n---------------") + for docname, category in API_CATEGORIES.items(): + label: str = docname.rpartition(".")[2] + heading: str = "-" * len(category.title) + page_content: str = f".. _{label}:\n\n{category.title}\n{heading}" + _write_generated(source_dir / f"{docname}.rst", page_content) + + +def _generate_object_pages( + app: Sphinx, + source_dir: Path, + object_targets: Mapping[str, Path], + fragments: Mapping[str, MaintainedFragment], +) -> None: + """Ask autosummary to create physical pages for objects without maintained overrides. + + Sphinx requires physical sources for individual class URLs. A temporary autosummary directive + supplies the generated object list without committing that list to RST. The resulting pages + remain in ``source_dir`` and are reused by later builds when their content is unchanged. + """ + maintained_targets: set[Path] = {fragment.wrapper_path for fragment in fragments.values()} + generated_objects: list[str] = [] + conflicting_targets: list[Path] = [] + # A maintained fragment replaces the default template; any other unmarked collision is unsafe. + for object_name, target_path in object_targets.items(): + if target_path in maintained_targets: + continue -def _specialized_entries(source_dir: Path, tree_docnames: Iterable[str]) -> list[str]: - entries = [] - for docname in tree_docnames: - entries.extend(_toctree_entries(source_dir / f"{docname}.rst")) + generated_objects.append(object_name) + if target_path.exists() and not _has_marker(target_path, GENERATED_MARKER): + conflicting_targets.append(target_path) - duplicates = sorted(name for name, count in Counter(entries).items() if count > 1) - if duplicates: - formatted = ", ".join(duplicates) + if conflicting_targets: + formatted_paths: str = "\n".join(f"* {path}" for path in conflicting_targets) raise ExtensionError( - f"API objects occur in more than one specialized toctree: {formatted}" + f"Refusing to overwrite maintained API documentation pages:\n{formatted_paths}" ) - return entries - - -def _render_toctree(entries: Iterable[str]) -> str: - body = "\n".join(f" {entry}" for entry in entries) - return f".. toctree::\n :titlesonly:\n\n{body}" - - -def _api_toctrees(source_dir: Path) -> dict[str, str]: - """Build the default package toctrees while preserving hand-curated topic groupings.""" - object_docnames = {_docname(name) for name in _api_object_names()} + # Autosummary reads this directive exactly as if it lived in a maintained RST document. + manifest_lines: list[str] = [ + ".. autosummary::", + " :toctree:", + " :template: ptb-object.rst", + " :signatures: none", + "", + ] + manifest_lines.extend(f" {object_name}" for object_name in generated_objects) + manifest_content: str = "\n".join(manifest_lines) + + # The manifest is merely input to autosummary; only its generated object pages must persist. + with tempfile.TemporaryDirectory(prefix="ptb-api-docs-") as temporary_directory: + manifest_path: Path = Path(temporary_directory) / "api.rst" + manifest_path.write_text(manifest_content, encoding="utf-8") + generate_autosummary_docs( + [str(manifest_path)], + output_dir=source_dir, + app=app, + overwrite=True, + encoding=app.config.source_encoding, + ) - top_level = {name for name in object_docnames if name.count(".") == 1} - top_specialized = _specialized_entries(source_dir, TOP_LEVEL_SPECIALIZED_TREES) - unknown_top = set(top_specialized).difference(top_level) - if unknown_top: - formatted = ", ".join(sorted(unknown_top)) - raise ExtensionError(f"Unknown objects in specialized telegram toctrees: {formatted}") - available_types = top_level.difference(top_specialized, {"telegram.bot"}) +def _generate_api_pages(app: Sphinx) -> None: + """Handle ``builder-inited`` before Sphinx discovers source documents. - ext = {name for name in object_docnames if name.startswith("telegram.ext.")} - ext_specialized = _specialized_entries(source_dir, EXT_SPECIALIZED_TREES) - allowed_manual_ext_pages = {"telegram.ext.filters"} - unknown_ext = set(ext_specialized).difference(ext, allowed_manual_ext_pages) - if unknown_ext: - formatted = ", ".join(sorted(unknown_ext)) - raise ExtensionError(f"Unknown objects in specialized telegram.ext toctrees: {formatted}") + The builder and configuration are ready at this point, but the environment has not scanned the + source directory. Creating and removing generated files here lets normal Sphinx discovery and + incremental-build logic handle them like ordinary RST sources. + """ + source_dir: Path = Path(app.srcdir) - ext_package = ext.difference(ext_specialized) - request = {name for name in object_docnames if name.startswith("telegram.request.")} + # Resolve every source path first, then synchronize wrappers and ordinary object pages. + object_targets: dict[str, Path] = _configure_object_targets(app, source_dir) + fragments: dict[str, MaintainedFragment] = _discover_maintained_fragments(source_dir) + _synchronize_compatibility_pages(source_dir, object_targets, fragments) + _generate_object_pages(app, source_dir, object_targets, fragments) - return { - "telegram.at-tree": _render_toctree(sorted(available_types)), - "telegram.ext": _render_toctree([*sorted(ext_package), *EXT_SPECIALIZED_TREES]), - "telegram.request": _render_toctree(sorted(request)), - } +def _inject_api_tree(app: Sphinx, docname: str, source: list[str]) -> None: + """Handle ``source-read`` by appending generated navigation before RST parsing. -def _inject_api_toctree(app: Sphinx, docname: str, source: list[str]) -> None: - """Replace a package-page marker with its generated toctree in memory.""" - marker = TOCTREE_MARKERS.get(docname) - if marker is None: + Sphinx passes source text in a one-item list so event handlers can replace it. The injected + tree remains absent from disk, while explicit dependencies ensure export changes invalidate + the page. + """ + entries: tuple[str, ...] | None = API_TREES.get(docname) + if not entries: return - if source[0].count(marker) != 1: - raise ExtensionError(f"{docname}.rst must contain exactly one {marker!r} marker") - - source[0] = source[0].replace(marker, _api_toctrees(Path(app.srcdir))[docname]) + # Physical RST mtimes cannot represent changes to text generated from Python exports. + for dependency in API_TREE_DEPENDENCIES: + app.env.note_dependency(dependency) -def _cleanup_api_pages(app: Sphinx, exception: Exception | None) -> None: - """Remove transient sources even when Sphinx reports a build exception.""" - _remove_generated_pages(Path(app.srcdir)) + # Replacing the list item changes the text Sphinx will parse without modifying the source file. + source[0] = f"{source[0].rstrip()}\n\n{_toctree(entries)}\n" -def setup(app: Sphinx) -> dict[str, object]: +def setup(app: Sphinx) -> ExtensionMetadata: + """Register page generation before discovery and tree injection before source parsing.""" + # Priority 400 runs before autosummary's builder-inited handler at the default priority 500. app.connect("builder-inited", _generate_api_pages, priority=400) - app.connect("source-read", _inject_api_toctree) - app.connect("build-finished", _cleanup_api_pages) + app.connect("source-read", _inject_api_tree) return { "version": "1.0", "parallel_read_safe": True, diff --git a/docs/source/_templates/ptb-object.rst b/docs/source/_templates/ptb-object.rst index fba97077716..1cd227e1364 100644 --- a/docs/source/_templates/ptb-object.rst +++ b/docs/source/_templates/ptb-object.rst @@ -1,8 +1,9 @@ -.. This file is generated by docs.auxil.api_docs. Do not edit it directly. +.. Autogenerated page: True {{ objname | escape | underline }} .. currentmodule:: {{ module }} .. auto{{ objtype }}:: {{ objname }}{% if objtype in ["class", "exception"] %} -{{ ptb_autodoc_option_blocks.get(fullname, ptb_default_autodoc_option_block) }}{% endif %} + :members: + :show-inheritance:{% endif %} diff --git a/docs/source/conf.py b/docs/source/conf.py index addc1c3b766..e1eb31219b7 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -82,6 +82,9 @@ # You can specify multiple suffix as a list of string: source_suffix = ".rst" +# These maintained fragments are included by generated documents with the historic dotted names. +exclude_patterns = ["examples/**", "telegram/**", "telegram_auxil/**"] + # The master toctree document. master_doc = "index" diff --git a/docs/source/examples.arbitrarycallbackdatabot.rst b/docs/source/examples.arbitrarycallbackdatabot.rst index 17eb22426e3..56f3b4b2ca7 100644 --- a/docs/source/examples.arbitrarycallbackdatabot.rst +++ b/docs/source/examples.arbitrarycallbackdatabot.rst @@ -1,7 +1,3 @@ -``arbitrarycallbackdatabot.py`` -=============================== +.. Autogenerated page: True -.. literalinclude:: ../../examples/arbitrarycallbackdatabot.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/arbitrarycallbackdatabot.rst diff --git a/docs/source/examples.chatmemberbot.rst b/docs/source/examples.chatmemberbot.rst index a913d340023..42f1a62c332 100644 --- a/docs/source/examples.chatmemberbot.rst +++ b/docs/source/examples.chatmemberbot.rst @@ -1,7 +1,3 @@ -``chatmemberbot.py`` -==================== +.. Autogenerated page: True -.. literalinclude:: ../../examples/chatmemberbot.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/chatmemberbot.rst diff --git a/docs/source/examples.contexttypesbot.rst b/docs/source/examples.contexttypesbot.rst index 62438ebc539..056de3ffc0d 100644 --- a/docs/source/examples.contexttypesbot.rst +++ b/docs/source/examples.contexttypesbot.rst @@ -1,7 +1,3 @@ -``contexttypesbot.py`` -====================== +.. Autogenerated page: True -.. literalinclude:: ../../examples/contexttypesbot.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/contexttypesbot.rst diff --git a/docs/source/examples.conversationbot.rst b/docs/source/examples.conversationbot.rst index 118f9feef6a..283023ac89b 100644 --- a/docs/source/examples.conversationbot.rst +++ b/docs/source/examples.conversationbot.rst @@ -1,13 +1,3 @@ -``conversationbot.py`` -====================== +.. Autogenerated page: True -.. literalinclude:: ../../examples/conversationbot.py - :language: python - :linenos: - -.. _conversationbot-diagram: - -State Diagram -------------- - -.. mermaid:: ../../examples/conversationbot.mmd +.. include:: examples/conversationbot.rst diff --git a/docs/source/examples.conversationbot2.rst b/docs/source/examples.conversationbot2.rst index 6219ecaabfe..66404c47eaf 100644 --- a/docs/source/examples.conversationbot2.rst +++ b/docs/source/examples.conversationbot2.rst @@ -1,13 +1,3 @@ -``conversationbot2.py`` -======================= +.. Autogenerated page: True -.. literalinclude:: ../../examples/conversationbot2.py - :language: python - :linenos: - -.. _conversationbot2-diagram: - -State Diagram -------------- - -.. mermaid:: ../../examples/conversationbot2.mmd +.. include:: examples/conversationbot2.rst diff --git a/docs/source/examples.customwebhookbot.rst b/docs/source/examples.customwebhookbot.rst index 74722093866..8303b3d7228 100644 --- a/docs/source/examples.customwebhookbot.rst +++ b/docs/source/examples.customwebhookbot.rst @@ -1,43 +1,3 @@ -``customwebhookbot.py`` -======================= +.. Autogenerated page: True -This example is available for different web frameworks. -You can select your preferred framework by opening one of the tabs above the code example. - -.. hint:: - - The following examples show how different Python web frameworks can be used alongside PTB. - This can be useful for two use cases: - - 1. For extending the functionality of your existing bot to handling updates of external services - 2. For extending the functionality of your exisiting web application to also include chat bot functionality - - How the PTB and web framework components of the examples below are viewed surely depends on which use case one has in mind. - We are fully aware that a combination of PTB with web frameworks will always mean finding a tradeoff between usability and best practices for both PTB and the web framework and these examples are certainly far from optimal solutions. - Please understand them as starting points and use your expertise of the web framework of your choosing to build up on them. - You are of course also very welcome to help improve these examples! - -.. tab:: ``starlette`` - - .. literalinclude:: ../../examples/customwebhookbot/starlettebot.py - :language: python - :linenos: - -.. tab:: ``flask`` - - .. literalinclude:: ../../examples/customwebhookbot/flaskbot.py - :language: python - :linenos: - -.. tab:: ``quart`` - - .. literalinclude:: ../../examples/customwebhookbot/quartbot.py - :language: python - :linenos: - -.. tab:: ``Django`` - - .. literalinclude:: ../../examples/customwebhookbot/djangobot.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/customwebhookbot.rst diff --git a/docs/source/examples.deeplinking.rst b/docs/source/examples.deeplinking.rst index 64960d5e550..1863415ad34 100644 --- a/docs/source/examples.deeplinking.rst +++ b/docs/source/examples.deeplinking.rst @@ -1,7 +1,3 @@ -``deeplinking.py`` -================== +.. Autogenerated page: True -.. literalinclude:: ../../examples/deeplinking.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/deeplinking.rst diff --git a/docs/source/examples.echobot.rst b/docs/source/examples.echobot.rst index a4e2401d375..7170f4d8583 100644 --- a/docs/source/examples.echobot.rst +++ b/docs/source/examples.echobot.rst @@ -1,7 +1,3 @@ -``echobot.py`` -============== +.. Autogenerated page: True -.. literalinclude:: ../../examples/echobot.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/echobot.rst diff --git a/docs/source/examples.errorhandlerbot.rst b/docs/source/examples.errorhandlerbot.rst index 3df82103332..c58a1338941 100644 --- a/docs/source/examples.errorhandlerbot.rst +++ b/docs/source/examples.errorhandlerbot.rst @@ -1,7 +1,3 @@ -``errorhandlerbot.py`` -====================== +.. Autogenerated page: True -.. literalinclude:: ../../examples/errorhandlerbot.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/errorhandlerbot.rst diff --git a/docs/source/examples.inlinebot.rst b/docs/source/examples.inlinebot.rst index dcf5df3fdc1..8329f3acfdf 100644 --- a/docs/source/examples.inlinebot.rst +++ b/docs/source/examples.inlinebot.rst @@ -1,7 +1,3 @@ -``inlinebot.py`` -================ +.. Autogenerated page: True -.. literalinclude:: ../../examples/inlinebot.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/inlinebot.rst diff --git a/docs/source/examples.inlinekeyboard.rst b/docs/source/examples.inlinekeyboard.rst index 16290cde351..668eb13adf0 100644 --- a/docs/source/examples.inlinekeyboard.rst +++ b/docs/source/examples.inlinekeyboard.rst @@ -1,7 +1,3 @@ -``inlinekeyboard.py`` -===================== +.. Autogenerated page: True -.. literalinclude:: ../../examples/inlinekeyboard.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/inlinekeyboard.rst diff --git a/docs/source/examples.inlinekeyboard2.rst b/docs/source/examples.inlinekeyboard2.rst index 936b4dab25b..828516825f6 100644 --- a/docs/source/examples.inlinekeyboard2.rst +++ b/docs/source/examples.inlinekeyboard2.rst @@ -1,7 +1,3 @@ -``inlinekeyboard2.py`` -====================== +.. Autogenerated page: True -.. literalinclude:: ../../examples/inlinekeyboard2.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/inlinekeyboard2.rst diff --git a/docs/source/examples.nestedconversationbot.rst b/docs/source/examples.nestedconversationbot.rst index 23c15053dfb..127956c09c1 100644 --- a/docs/source/examples.nestedconversationbot.rst +++ b/docs/source/examples.nestedconversationbot.rst @@ -1,13 +1,3 @@ -``nestedconversationbot.py`` -============================ +.. Autogenerated page: True -.. literalinclude:: ../../examples/nestedconversationbot.py - :language: python - :linenos: - -.. _nestedconversationbot-diagram: - -State Diagram -------------- - -.. mermaid:: ../../examples/nestedconversationbot.mmd +.. include:: examples/nestedconversationbot.rst diff --git a/docs/source/examples.passportbot.rst b/docs/source/examples.passportbot.rst index 74c3306c843..a19badb2335 100644 --- a/docs/source/examples.passportbot.rst +++ b/docs/source/examples.passportbot.rst @@ -1,16 +1,3 @@ -``passportbot.py`` -================== +.. Autogenerated page: True -.. literalinclude:: ../../examples/passportbot.py - :language: python - :linenos: - -.. _passportbot-html: - -HTML Page ---------- - -.. literalinclude:: ../../examples/passportbot.html - :language: html - :linenos: - \ No newline at end of file +.. include:: examples/passportbot.rst diff --git a/docs/source/examples.paymentbot.rst b/docs/source/examples.paymentbot.rst index dd6c158f2fa..2cb1b5221ec 100644 --- a/docs/source/examples.paymentbot.rst +++ b/docs/source/examples.paymentbot.rst @@ -1,7 +1,3 @@ -``paymentbot.py`` -================= +.. Autogenerated page: True -.. literalinclude:: ../../examples/paymentbot.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/paymentbot.rst diff --git a/docs/source/examples.persistentconversationbot.rst b/docs/source/examples.persistentconversationbot.rst index 07203fbe80f..81cb04fa9a7 100644 --- a/docs/source/examples.persistentconversationbot.rst +++ b/docs/source/examples.persistentconversationbot.rst @@ -1,7 +1,3 @@ -``persistentconversationbot.py`` -================================ +.. Autogenerated page: True -.. literalinclude:: ../../examples/persistentconversationbot.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/persistentconversationbot.rst diff --git a/docs/source/examples.pollbot.rst b/docs/source/examples.pollbot.rst index 9fed7231a27..228990a78a3 100644 --- a/docs/source/examples.pollbot.rst +++ b/docs/source/examples.pollbot.rst @@ -1,7 +1,3 @@ -``pollbot.py`` -============== +.. Autogenerated page: True -.. literalinclude:: ../../examples/pollbot.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/pollbot.rst diff --git a/docs/source/examples.rawapibot.rst b/docs/source/examples.rawapibot.rst index 61e66a6e22e..74afa88d744 100644 --- a/docs/source/examples.rawapibot.rst +++ b/docs/source/examples.rawapibot.rst @@ -1,11 +1,3 @@ -`rawapibot.py` -============== +.. Autogenerated page: True -This example uses only the pure, "bare-metal" API wrapper. - - - -.. literalinclude:: ../../examples/rawapibot.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/rawapibot.rst diff --git a/docs/source/examples.rst b/docs/source/examples.rst index ce87c73450e..e5e84cb216d 100644 --- a/docs/source/examples.rst +++ b/docs/source/examples.rst @@ -1,196 +1,3 @@ -Examples -======== - -In this section we display small examples to show what a bot written with -``python-telegram-bot`` looks like. -Some bots focus on one specific -aspect of the Telegram Bot API while others focus on one of the -mechanics of this library. Except for the -:any:`examples.rawapibot` example, they all use the high-level -framework this library provides with the -:mod:`telegram.ext` submodule. - -All examples are licensed under the `CC0 -License `__ -and are therefore fully dedicated to the public domain. You can use them -as the base for your own bots without worrying about copyrights. - -Do note that we ignore one pythonic convention. Best practice would -dictate, in many handler callbacks function signatures, to replace the -argument ``context`` with an underscore, since ``context`` is an unused -local variable in those callbacks. However, since these are examples and -not having a name for that argument confuses beginners, we decided to -have it present. - -:any:`examples.echobot` ------------------------ - -This is probably the base for most of the bots made with -``python-telegram-bot``. It simply replies to each text message with a -message that contains the same text. - -:any:`examples.timerbot` ------------------------- - -This bot uses the -:class:`telegram.ext.JobQueue` -class to send timed messages. The user sets a timer by using ``/set`` -command with a specific time, for example ``/set 30``. The bot then sets -up a job to send a message to that user after 30 seconds. The user can -also cancel the timer by sending ``/unset``. To learn more about the -``JobQueue``, read `this wiki article `__. -Note: To use ``JobQueue``, you must install PTB via ``pip install "python-telegram-bot[job-queue]"`` - -:any:`examples.conversationbot` -------------------------------- - -A common task for a bot is to ask information from the user. In v5.0 of -this library, we introduced the -:class:`telegram.ext.ConversationHandler` -for that exact purpose. This example uses it to retrieve -user-information in a conversation-like style. To get a better -understanding, take a look at the :ref:`state diagram `. - -:any:`examples.conversationbot2` --------------------------------- - -A more complex example of a bot that uses the ``ConversationHandler``. -It is also more confusing. Good thing there is a :ref:`fancy state diagram `. -for this one, too! - -:any:`examples.nestedconversationbot` -------------------------------------- - -An even more complex example of a bot that uses the nested -``ConversationHandler``\ s. While it’s certainly not that complex that -you couldn’t built it without nested ``ConversationHanldler``\ s, it -gives a good impression on how to work with them. Of course, there is a -:ref:`fancy state diagram ` -for this example, too! - -:any:`examples.persistentconversationbot` ------------------------------------------ - -A basic example of a bot store conversation state and user_data over -multiple restarts. - -:any:`examples.inlinekeyboard` ------------------------------- - -This example sheds some light on inline keyboards, callback queries and -message editing. A wiki site explaining this examples lives -`here `__. - -:any:`examples.inlinekeyboard2` -------------------------------- - -A more complex example about inline keyboards, callback queries and -message editing. This example showcases how an interactive menu could be -build using inline keyboards. - -:any:`examples.deeplinking` ---------------------------- - -A basic example on how to use deeplinking with inline keyboards. - -:any:`examples.inlinebot` -------------------------- - -A basic example of an `inline -bot `__. Don’t forget to enable -inline mode with `@BotFather `_. - -:any:`examples.pollbot` ------------------------ - -This example sheds some light on polls, poll answers and the -corresponding handlers. - -:any:`examples.passportbot` ---------------------------- - -A basic example of a bot that can accept passports. Use in combination -with the :ref:`HTML page `. -Don’t forget to enable and configure payments with -`@BotFather `_. Check out this -`guide `__ -on Telegram passports in PTB. -Note: To use Telegram Passport, you must install PTB via ``pip install "python-telegram-bot[passport]"`` - -:any:`examples.paymentbot` --------------------------- - -A basic example of a bot that can accept payments. Don’t forget to -enable and configure payments with -`@BotFather `_. - -:any:`examples.errorhandlerbot` -------------------------------- - -A basic example on how to set up a custom error handler. - -:any:`examples.chatmemberbot` ------------------------------ - -A basic example on how ``(my_)chat_member`` updates can be used. - -:any:`examples.webappbot` -------------------------- - -A basic example of how `Telegram -WebApps `__ can be used. Use in -combination with the :ref:`HTML page `. -For your convenience, this file is hosted by the PTB team such that you -don’t need to host it yourself. Uses the -`iro.js `__ JavaScript library to showcase a -user interface that is hard to achieve with native Telegram -functionality. - -:any:`examples.contexttypesbot` -------------------------------- - -This example showcases how ``telegram.ext.ContextTypes`` can be used to -customize the ``context`` argument of handler and job callbacks. - -:any:`examples.customwebhookbot` --------------------------------- - -This example showcases how a custom webhook setup can be used in -combination with ``telegram.ext.Application``. - -:any:`examples.arbitrarycallbackdatabot` ----------------------------------------- - -This example showcases how PTBs “arbitrary callback data” feature can be -used. -Note: To use arbitrary callback data, you must install PTB via ``pip install "python-telegram-bot[callback-data]"`` - -Pure API --------- - -The :any:`examples.rawapibot` example example uses only the pure, “bare-metal” API wrapper. - -.. toctree:: - :hidden: - - examples.arbitrarycallbackdatabot - examples.chatmemberbot - examples.contexttypesbot - examples.conversationbot - examples.conversationbot2 - examples.customwebhookbot - examples.deeplinking - examples.echobot - examples.errorhandlerbot - examples.inlinebot - examples.inlinekeyboard - examples.inlinekeyboard2 - examples.nestedconversationbot - examples.passportbot - examples.paymentbot - examples.persistentconversationbot - examples.pollbot - examples.rawapibot - examples.timerbot - examples.webappbot +.. Autogenerated page: True +.. include:: examples/index.rst diff --git a/docs/source/examples.timerbot.rst b/docs/source/examples.timerbot.rst index 89f29fb096f..f803991271d 100644 --- a/docs/source/examples.timerbot.rst +++ b/docs/source/examples.timerbot.rst @@ -1,7 +1,3 @@ -``timerbot.py`` -=============== +.. Autogenerated page: True -.. literalinclude:: ../../examples/timerbot.py - :language: python - :linenos: - \ No newline at end of file +.. include:: examples/timerbot.rst diff --git a/docs/source/examples.webappbot.rst b/docs/source/examples.webappbot.rst index 55a8141308d..ebe452f7130 100644 --- a/docs/source/examples.webappbot.rst +++ b/docs/source/examples.webappbot.rst @@ -1,16 +1,3 @@ -``webappbot.py`` -================ +.. Autogenerated page: True -.. literalinclude:: ../../examples/webappbot.py - :language: python - :linenos: - -.. _webappbot-html: - -HTML Page ---------- - -.. literalinclude:: ../../examples/webappbot.html - :language: html - :linenos: - \ No newline at end of file +.. include:: examples/webappbot.rst diff --git a/docs/source/examples/arbitrarycallbackdatabot.rst b/docs/source/examples/arbitrarycallbackdatabot.rst new file mode 100644 index 00000000000..9f2f73c74ba --- /dev/null +++ b/docs/source/examples/arbitrarycallbackdatabot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``arbitrarycallbackdatabot.py`` +=============================== + +.. literalinclude:: ../../examples/arbitrarycallbackdatabot.py + :language: python + :linenos: diff --git a/docs/source/examples/chatmemberbot.rst b/docs/source/examples/chatmemberbot.rst new file mode 100644 index 00000000000..fa94c43c09b --- /dev/null +++ b/docs/source/examples/chatmemberbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``chatmemberbot.py`` +==================== + +.. literalinclude:: ../../examples/chatmemberbot.py + :language: python + :linenos: diff --git a/docs/source/examples/contexttypesbot.rst b/docs/source/examples/contexttypesbot.rst new file mode 100644 index 00000000000..f0a8efd2c64 --- /dev/null +++ b/docs/source/examples/contexttypesbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``contexttypesbot.py`` +====================== + +.. literalinclude:: ../../examples/contexttypesbot.py + :language: python + :linenos: diff --git a/docs/source/examples/conversationbot.rst b/docs/source/examples/conversationbot.rst new file mode 100644 index 00000000000..11210542c99 --- /dev/null +++ b/docs/source/examples/conversationbot.rst @@ -0,0 +1,15 @@ +.. Autogenerated page: False + +``conversationbot.py`` +====================== + +.. literalinclude:: ../../examples/conversationbot.py + :language: python + :linenos: + +.. _conversationbot-diagram: + +State Diagram +------------- + +.. mermaid:: ../../examples/conversationbot.mmd diff --git a/docs/source/examples/conversationbot2.rst b/docs/source/examples/conversationbot2.rst new file mode 100644 index 00000000000..f9251efe8e1 --- /dev/null +++ b/docs/source/examples/conversationbot2.rst @@ -0,0 +1,15 @@ +.. Autogenerated page: False + +``conversationbot2.py`` +======================= + +.. literalinclude:: ../../examples/conversationbot2.py + :language: python + :linenos: + +.. _conversationbot2-diagram: + +State Diagram +------------- + +.. mermaid:: ../../examples/conversationbot2.mmd diff --git a/docs/source/examples/customwebhookbot.rst b/docs/source/examples/customwebhookbot.rst new file mode 100644 index 00000000000..bc37a2460f1 --- /dev/null +++ b/docs/source/examples/customwebhookbot.rst @@ -0,0 +1,44 @@ +.. Autogenerated page: False + +``customwebhookbot.py`` +======================= + +This example is available for different web frameworks. +You can select your preferred framework by opening one of the tabs above the code example. + +.. hint:: + + The following examples show how different Python web frameworks can be used alongside PTB. + This can be useful for two use cases: + + 1. For extending the functionality of your existing bot to handling updates of external services + 2. For extending the functionality of your exisiting web application to also include chat bot functionality + + How the PTB and web framework components of the examples below are viewed surely depends on which use case one has in mind. + We are fully aware that a combination of PTB with web frameworks will always mean finding a tradeoff between usability and best practices for both PTB and the web framework and these examples are certainly far from optimal solutions. + Please understand them as starting points and use your expertise of the web framework of your choosing to build up on them. + You are of course also very welcome to help improve these examples! + +.. tab:: ``starlette`` + + .. literalinclude:: ../../examples/customwebhookbot/starlettebot.py + :language: python + :linenos: + +.. tab:: ``flask`` + + .. literalinclude:: ../../examples/customwebhookbot/flaskbot.py + :language: python + :linenos: + +.. tab:: ``quart`` + + .. literalinclude:: ../../examples/customwebhookbot/quartbot.py + :language: python + :linenos: + +.. tab:: ``Django`` + + .. literalinclude:: ../../examples/customwebhookbot/djangobot.py + :language: python + :linenos: diff --git a/docs/source/examples/deeplinking.rst b/docs/source/examples/deeplinking.rst new file mode 100644 index 00000000000..a286ad1e573 --- /dev/null +++ b/docs/source/examples/deeplinking.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``deeplinking.py`` +================== + +.. literalinclude:: ../../examples/deeplinking.py + :language: python + :linenos: diff --git a/docs/source/examples/echobot.rst b/docs/source/examples/echobot.rst new file mode 100644 index 00000000000..db246de4ebe --- /dev/null +++ b/docs/source/examples/echobot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``echobot.py`` +============== + +.. literalinclude:: ../../examples/echobot.py + :language: python + :linenos: diff --git a/docs/source/examples/errorhandlerbot.rst b/docs/source/examples/errorhandlerbot.rst new file mode 100644 index 00000000000..7d3db4c0bce --- /dev/null +++ b/docs/source/examples/errorhandlerbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``errorhandlerbot.py`` +====================== + +.. literalinclude:: ../../examples/errorhandlerbot.py + :language: python + :linenos: diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst new file mode 100644 index 00000000000..47efb05478f --- /dev/null +++ b/docs/source/examples/index.rst @@ -0,0 +1,197 @@ +.. Autogenerated page: False + +Examples +======== + +In this section we display small examples to show what a bot written with +``python-telegram-bot`` looks like. +Some bots focus on one specific +aspect of the Telegram Bot API while others focus on one of the +mechanics of this library. Except for the +:any:`examples.rawapibot` example, they all use the high-level +framework this library provides with the +:mod:`telegram.ext` submodule. + +All examples are licensed under the `CC0 +License `__ +and are therefore fully dedicated to the public domain. You can use them +as the base for your own bots without worrying about copyrights. + +Do note that we ignore one pythonic convention. Best practice would +dictate, in many handler callbacks function signatures, to replace the +argument ``context`` with an underscore, since ``context`` is an unused +local variable in those callbacks. However, since these are examples and +not having a name for that argument confuses beginners, we decided to +have it present. + +:any:`examples.echobot` +----------------------- + +This is probably the base for most of the bots made with +``python-telegram-bot``. It simply replies to each text message with a +message that contains the same text. + +:any:`examples.timerbot` +------------------------ + +This bot uses the +:class:`telegram.ext.JobQueue` +class to send timed messages. The user sets a timer by using ``/set`` +command with a specific time, for example ``/set 30``. The bot then sets +up a job to send a message to that user after 30 seconds. The user can +also cancel the timer by sending ``/unset``. To learn more about the +``JobQueue``, read `this wiki article `__. +Note: To use ``JobQueue``, you must install PTB via ``pip install "python-telegram-bot[job-queue]"`` + +:any:`examples.conversationbot` +------------------------------- + +A common task for a bot is to ask information from the user. In v5.0 of +this library, we introduced the +:class:`telegram.ext.ConversationHandler` +for that exact purpose. This example uses it to retrieve +user-information in a conversation-like style. To get a better +understanding, take a look at the :ref:`state diagram `. + +:any:`examples.conversationbot2` +-------------------------------- + +A more complex example of a bot that uses the ``ConversationHandler``. +It is also more confusing. Good thing there is a :ref:`fancy state diagram `. +for this one, too! + +:any:`examples.nestedconversationbot` +------------------------------------- + +An even more complex example of a bot that uses the nested +``ConversationHandler``\ s. While it’s certainly not that complex that +you couldn’t built it without nested ``ConversationHanldler``\ s, it +gives a good impression on how to work with them. Of course, there is a +:ref:`fancy state diagram ` +for this example, too! + +:any:`examples.persistentconversationbot` +----------------------------------------- + +A basic example of a bot store conversation state and user_data over +multiple restarts. + +:any:`examples.inlinekeyboard` +------------------------------ + +This example sheds some light on inline keyboards, callback queries and +message editing. A wiki site explaining this examples lives +`here `__. + +:any:`examples.inlinekeyboard2` +------------------------------- + +A more complex example about inline keyboards, callback queries and +message editing. This example showcases how an interactive menu could be +build using inline keyboards. + +:any:`examples.deeplinking` +--------------------------- + +A basic example on how to use deeplinking with inline keyboards. + +:any:`examples.inlinebot` +------------------------- + +A basic example of an `inline +bot `__. Don’t forget to enable +inline mode with `@BotFather `_. + +:any:`examples.pollbot` +----------------------- + +This example sheds some light on polls, poll answers and the +corresponding handlers. + +:any:`examples.passportbot` +--------------------------- + +A basic example of a bot that can accept passports. Use in combination +with the :ref:`HTML page `. +Don’t forget to enable and configure payments with +`@BotFather `_. Check out this +`guide `__ +on Telegram passports in PTB. +Note: To use Telegram Passport, you must install PTB via ``pip install "python-telegram-bot[passport]"`` + +:any:`examples.paymentbot` +-------------------------- + +A basic example of a bot that can accept payments. Don’t forget to +enable and configure payments with +`@BotFather `_. + +:any:`examples.errorhandlerbot` +------------------------------- + +A basic example on how to set up a custom error handler. + +:any:`examples.chatmemberbot` +----------------------------- + +A basic example on how ``(my_)chat_member`` updates can be used. + +:any:`examples.webappbot` +------------------------- + +A basic example of how `Telegram +WebApps `__ can be used. Use in +combination with the :ref:`HTML page `. +For your convenience, this file is hosted by the PTB team such that you +don’t need to host it yourself. Uses the +`iro.js `__ JavaScript library to showcase a +user interface that is hard to achieve with native Telegram +functionality. + +:any:`examples.contexttypesbot` +------------------------------- + +This example showcases how ``telegram.ext.ContextTypes`` can be used to +customize the ``context`` argument of handler and job callbacks. + +:any:`examples.customwebhookbot` +-------------------------------- + +This example showcases how a custom webhook setup can be used in +combination with ``telegram.ext.Application``. + +:any:`examples.arbitrarycallbackdatabot` +---------------------------------------- + +This example showcases how PTBs “arbitrary callback data” feature can be +used. +Note: To use arbitrary callback data, you must install PTB via ``pip install "python-telegram-bot[callback-data]"`` + +Pure API +-------- + +The :any:`examples.rawapibot` example example uses only the pure, “bare-metal” API wrapper. + +.. toctree:: + :hidden: + + examples.arbitrarycallbackdatabot + examples.chatmemberbot + examples.contexttypesbot + examples.conversationbot + examples.conversationbot2 + examples.customwebhookbot + examples.deeplinking + examples.echobot + examples.errorhandlerbot + examples.inlinebot + examples.inlinekeyboard + examples.inlinekeyboard2 + examples.nestedconversationbot + examples.passportbot + examples.paymentbot + examples.persistentconversationbot + examples.pollbot + examples.rawapibot + examples.timerbot + examples.webappbot diff --git a/docs/source/examples/inlinebot.rst b/docs/source/examples/inlinebot.rst new file mode 100644 index 00000000000..518546bf78e --- /dev/null +++ b/docs/source/examples/inlinebot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``inlinebot.py`` +================ + +.. literalinclude:: ../../examples/inlinebot.py + :language: python + :linenos: diff --git a/docs/source/examples/inlinekeyboard.rst b/docs/source/examples/inlinekeyboard.rst new file mode 100644 index 00000000000..e9b26278dc6 --- /dev/null +++ b/docs/source/examples/inlinekeyboard.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``inlinekeyboard.py`` +===================== + +.. literalinclude:: ../../examples/inlinekeyboard.py + :language: python + :linenos: diff --git a/docs/source/examples/inlinekeyboard2.rst b/docs/source/examples/inlinekeyboard2.rst new file mode 100644 index 00000000000..15d0d25cd4b --- /dev/null +++ b/docs/source/examples/inlinekeyboard2.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``inlinekeyboard2.py`` +====================== + +.. literalinclude:: ../../examples/inlinekeyboard2.py + :language: python + :linenos: diff --git a/docs/source/examples/nestedconversationbot.rst b/docs/source/examples/nestedconversationbot.rst new file mode 100644 index 00000000000..4e32d8c3126 --- /dev/null +++ b/docs/source/examples/nestedconversationbot.rst @@ -0,0 +1,15 @@ +.. Autogenerated page: False + +``nestedconversationbot.py`` +============================ + +.. literalinclude:: ../../examples/nestedconversationbot.py + :language: python + :linenos: + +.. _nestedconversationbot-diagram: + +State Diagram +------------- + +.. mermaid:: ../../examples/nestedconversationbot.mmd diff --git a/docs/source/examples/passportbot.rst b/docs/source/examples/passportbot.rst new file mode 100644 index 00000000000..938ad7f537d --- /dev/null +++ b/docs/source/examples/passportbot.rst @@ -0,0 +1,17 @@ +.. Autogenerated page: False + +``passportbot.py`` +================== + +.. literalinclude:: ../../examples/passportbot.py + :language: python + :linenos: + +.. _passportbot-html: + +HTML Page +--------- + +.. literalinclude:: ../../examples/passportbot.html + :language: html + :linenos: diff --git a/docs/source/examples/paymentbot.rst b/docs/source/examples/paymentbot.rst new file mode 100644 index 00000000000..0f296409a13 --- /dev/null +++ b/docs/source/examples/paymentbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``paymentbot.py`` +================= + +.. literalinclude:: ../../examples/paymentbot.py + :language: python + :linenos: diff --git a/docs/source/examples/persistentconversationbot.rst b/docs/source/examples/persistentconversationbot.rst new file mode 100644 index 00000000000..f632a6bfcb3 --- /dev/null +++ b/docs/source/examples/persistentconversationbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``persistentconversationbot.py`` +================================ + +.. literalinclude:: ../../examples/persistentconversationbot.py + :language: python + :linenos: diff --git a/docs/source/examples/pollbot.rst b/docs/source/examples/pollbot.rst new file mode 100644 index 00000000000..d14f5c73ec9 --- /dev/null +++ b/docs/source/examples/pollbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``pollbot.py`` +============== + +.. literalinclude:: ../../examples/pollbot.py + :language: python + :linenos: diff --git a/docs/source/examples/rawapibot.rst b/docs/source/examples/rawapibot.rst new file mode 100644 index 00000000000..08977e3057a --- /dev/null +++ b/docs/source/examples/rawapibot.rst @@ -0,0 +1,12 @@ +.. Autogenerated page: False + +`rawapibot.py` +============== + +This example uses only the pure, "bare-metal" API wrapper. + + + +.. literalinclude:: ../../examples/rawapibot.py + :language: python + :linenos: diff --git a/docs/source/examples/timerbot.rst b/docs/source/examples/timerbot.rst new file mode 100644 index 00000000000..3c4b8ff73d4 --- /dev/null +++ b/docs/source/examples/timerbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +``timerbot.py`` +=============== + +.. literalinclude:: ../../examples/timerbot.py + :language: python + :linenos: diff --git a/docs/source/examples/webappbot.rst b/docs/source/examples/webappbot.rst new file mode 100644 index 00000000000..a51a1e4e0d2 --- /dev/null +++ b/docs/source/examples/webappbot.rst @@ -0,0 +1,17 @@ +.. Autogenerated page: False + +``webappbot.py`` +================ + +.. literalinclude:: ../../examples/webappbot.py + :language: python + :linenos: + +.. _webappbot-html: + +HTML Page +--------- + +.. literalinclude:: ../../examples/webappbot.html + :language: html + :linenos: diff --git a/docs/source/telegram.acceptedgifttypes.rst b/docs/source/telegram.acceptedgifttypes.rst new file mode 100644 index 00000000000..eea436aad03 --- /dev/null +++ b/docs/source/telegram.acceptedgifttypes.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +AcceptedGiftTypes +================= + +.. currentmodule:: telegram + +.. autoclass:: AcceptedGiftTypes + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.affiliateinfo.rst b/docs/source/telegram.affiliateinfo.rst new file mode 100644 index 00000000000..ec54f31a6e3 --- /dev/null +++ b/docs/source/telegram.affiliateinfo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +AffiliateInfo +============= + +.. currentmodule:: telegram + +.. autoclass:: AffiliateInfo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.animation.rst b/docs/source/telegram.animation.rst new file mode 100644 index 00000000000..34bf457a243 --- /dev/null +++ b/docs/source/telegram.animation.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Animation +========= + +.. currentmodule:: telegram + +.. autoclass:: Animation + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.at-tree.rst b/docs/source/telegram.at-tree.rst index 75f30e055ee..cb81b2ba7c7 100644 --- a/docs/source/telegram.at-tree.rst +++ b/docs/source/telegram.at-tree.rst @@ -1,4 +1,4 @@ +.. Autogenerated page: True + Available Types --------------- - -.. ptb-api-toctree:: available-types diff --git a/docs/source/telegram.audio.rst b/docs/source/telegram.audio.rst new file mode 100644 index 00000000000..a67bbccfe54 --- /dev/null +++ b/docs/source/telegram.audio.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Audio +===== + +.. currentmodule:: telegram + +.. autoclass:: Audio + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundfill.rst b/docs/source/telegram.backgroundfill.rst new file mode 100644 index 00000000000..185b7a46336 --- /dev/null +++ b/docs/source/telegram.backgroundfill.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BackgroundFill +============== + +.. currentmodule:: telegram + +.. autoclass:: BackgroundFill + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundfillfreeformgradient.rst b/docs/source/telegram.backgroundfillfreeformgradient.rst new file mode 100644 index 00000000000..e138a2152d9 --- /dev/null +++ b/docs/source/telegram.backgroundfillfreeformgradient.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BackgroundFillFreeformGradient +============================== + +.. currentmodule:: telegram + +.. autoclass:: BackgroundFillFreeformGradient + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundfillgradient.rst b/docs/source/telegram.backgroundfillgradient.rst new file mode 100644 index 00000000000..3d8718efecc --- /dev/null +++ b/docs/source/telegram.backgroundfillgradient.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BackgroundFillGradient +====================== + +.. currentmodule:: telegram + +.. autoclass:: BackgroundFillGradient + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundfillsolid.rst b/docs/source/telegram.backgroundfillsolid.rst new file mode 100644 index 00000000000..0b842d76339 --- /dev/null +++ b/docs/source/telegram.backgroundfillsolid.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BackgroundFillSolid +=================== + +.. currentmodule:: telegram + +.. autoclass:: BackgroundFillSolid + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtype.rst b/docs/source/telegram.backgroundtype.rst new file mode 100644 index 00000000000..c885aaee941 --- /dev/null +++ b/docs/source/telegram.backgroundtype.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BackgroundType +============== + +.. currentmodule:: telegram + +.. autoclass:: BackgroundType + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtypechattheme.rst b/docs/source/telegram.backgroundtypechattheme.rst new file mode 100644 index 00000000000..1728bb7644d --- /dev/null +++ b/docs/source/telegram.backgroundtypechattheme.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BackgroundTypeChatTheme +======================= + +.. currentmodule:: telegram + +.. autoclass:: BackgroundTypeChatTheme + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtypefill.rst b/docs/source/telegram.backgroundtypefill.rst new file mode 100644 index 00000000000..7c2a9538b3c --- /dev/null +++ b/docs/source/telegram.backgroundtypefill.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BackgroundTypeFill +================== + +.. currentmodule:: telegram + +.. autoclass:: BackgroundTypeFill + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtypepattern.rst b/docs/source/telegram.backgroundtypepattern.rst new file mode 100644 index 00000000000..fd4bb24f7e4 --- /dev/null +++ b/docs/source/telegram.backgroundtypepattern.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BackgroundTypePattern +===================== + +.. currentmodule:: telegram + +.. autoclass:: BackgroundTypePattern + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.backgroundtypewallpaper.rst b/docs/source/telegram.backgroundtypewallpaper.rst new file mode 100644 index 00000000000..914bc296771 --- /dev/null +++ b/docs/source/telegram.backgroundtypewallpaper.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BackgroundTypeWallpaper +======================= + +.. currentmodule:: telegram + +.. autoclass:: BackgroundTypeWallpaper + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.birthdate.rst b/docs/source/telegram.birthdate.rst new file mode 100644 index 00000000000..c32e048c450 --- /dev/null +++ b/docs/source/telegram.birthdate.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Birthdate +========= + +.. currentmodule:: telegram + +.. autoclass:: Birthdate + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.bot.rst b/docs/source/telegram.bot.rst new file mode 100644 index 00000000000..f5c6df37518 --- /dev/null +++ b/docs/source/telegram.bot.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Bot +=== + +.. currentmodule:: telegram + +.. autoclass:: Bot + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botaccesssettings.rst b/docs/source/telegram.botaccesssettings.rst new file mode 100644 index 00000000000..9ecbb626e54 --- /dev/null +++ b/docs/source/telegram.botaccesssettings.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BotAccessSettings +================= + +.. currentmodule:: telegram + +.. autoclass:: BotAccessSettings + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommand.rst b/docs/source/telegram.botcommand.rst new file mode 100644 index 00000000000..ade450995dd --- /dev/null +++ b/docs/source/telegram.botcommand.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BotCommand +========== + +.. currentmodule:: telegram + +.. autoclass:: BotCommand + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscope.rst b/docs/source/telegram.botcommandscope.rst new file mode 100644 index 00000000000..9521b00b3a6 --- /dev/null +++ b/docs/source/telegram.botcommandscope.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BotCommandScope +=============== + +.. currentmodule:: telegram + +.. autoclass:: BotCommandScope + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopeallchatadministrators.rst b/docs/source/telegram.botcommandscopeallchatadministrators.rst new file mode 100644 index 00000000000..eb941e1065c --- /dev/null +++ b/docs/source/telegram.botcommandscopeallchatadministrators.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BotCommandScopeAllChatAdministrators +==================================== + +.. currentmodule:: telegram + +.. autoclass:: BotCommandScopeAllChatAdministrators + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopeallgroupchats.rst b/docs/source/telegram.botcommandscopeallgroupchats.rst new file mode 100644 index 00000000000..ef05f7176a9 --- /dev/null +++ b/docs/source/telegram.botcommandscopeallgroupchats.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BotCommandScopeAllGroupChats +============================ + +.. currentmodule:: telegram + +.. autoclass:: BotCommandScopeAllGroupChats + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopeallprivatechats.rst b/docs/source/telegram.botcommandscopeallprivatechats.rst new file mode 100644 index 00000000000..66ed7dffbf6 --- /dev/null +++ b/docs/source/telegram.botcommandscopeallprivatechats.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BotCommandScopeAllPrivateChats +============================== + +.. currentmodule:: telegram + +.. autoclass:: BotCommandScopeAllPrivateChats + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopechat.rst b/docs/source/telegram.botcommandscopechat.rst new file mode 100644 index 00000000000..852ce8b7316 --- /dev/null +++ b/docs/source/telegram.botcommandscopechat.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BotCommandScopeChat +=================== + +.. currentmodule:: telegram + +.. autoclass:: BotCommandScopeChat + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopechatadministrators.rst b/docs/source/telegram.botcommandscopechatadministrators.rst new file mode 100644 index 00000000000..5957f0d0d37 --- /dev/null +++ b/docs/source/telegram.botcommandscopechatadministrators.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BotCommandScopeChatAdministrators +================================= + +.. currentmodule:: telegram + +.. autoclass:: BotCommandScopeChatAdministrators + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopechatmember.rst b/docs/source/telegram.botcommandscopechatmember.rst new file mode 100644 index 00000000000..2647555b08e --- /dev/null +++ b/docs/source/telegram.botcommandscopechatmember.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BotCommandScopeChatMember +========================= + +.. currentmodule:: telegram + +.. autoclass:: BotCommandScopeChatMember + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botcommandscopedefault.rst b/docs/source/telegram.botcommandscopedefault.rst new file mode 100644 index 00000000000..2d45f1d3903 --- /dev/null +++ b/docs/source/telegram.botcommandscopedefault.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BotCommandScopeDefault +====================== + +.. currentmodule:: telegram + +.. autoclass:: BotCommandScopeDefault + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botdescription.rst b/docs/source/telegram.botdescription.rst new file mode 100644 index 00000000000..56855aa6d44 --- /dev/null +++ b/docs/source/telegram.botdescription.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BotDescription +============== + +.. currentmodule:: telegram + +.. autoclass:: BotDescription + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botname.rst b/docs/source/telegram.botname.rst new file mode 100644 index 00000000000..44f83549af9 --- /dev/null +++ b/docs/source/telegram.botname.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BotName +======= + +.. currentmodule:: telegram + +.. autoclass:: BotName + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.botshortdescription.rst b/docs/source/telegram.botshortdescription.rst new file mode 100644 index 00000000000..b43c42d95b0 --- /dev/null +++ b/docs/source/telegram.botshortdescription.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BotShortDescription +=================== + +.. currentmodule:: telegram + +.. autoclass:: BotShortDescription + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessbotrights.rst b/docs/source/telegram.businessbotrights.rst new file mode 100644 index 00000000000..b981552c13d --- /dev/null +++ b/docs/source/telegram.businessbotrights.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BusinessBotRights +================= + +.. currentmodule:: telegram + +.. autoclass:: BusinessBotRights + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessconnection.rst b/docs/source/telegram.businessconnection.rst new file mode 100644 index 00000000000..7848c37fbed --- /dev/null +++ b/docs/source/telegram.businessconnection.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BusinessConnection +================== + +.. currentmodule:: telegram + +.. autoclass:: BusinessConnection + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessintro.rst b/docs/source/telegram.businessintro.rst new file mode 100644 index 00000000000..e2ae9d25b72 --- /dev/null +++ b/docs/source/telegram.businessintro.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BusinessIntro +============= + +.. currentmodule:: telegram + +.. autoclass:: BusinessIntro + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businesslocation.rst b/docs/source/telegram.businesslocation.rst new file mode 100644 index 00000000000..6174170c65b --- /dev/null +++ b/docs/source/telegram.businesslocation.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BusinessLocation +================ + +.. currentmodule:: telegram + +.. autoclass:: BusinessLocation + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessmessagesdeleted.rst b/docs/source/telegram.businessmessagesdeleted.rst new file mode 100644 index 00000000000..34d344ef541 --- /dev/null +++ b/docs/source/telegram.businessmessagesdeleted.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BusinessMessagesDeleted +======================= + +.. currentmodule:: telegram + +.. autoclass:: BusinessMessagesDeleted + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessopeninghours.rst b/docs/source/telegram.businessopeninghours.rst new file mode 100644 index 00000000000..c9d3174049d --- /dev/null +++ b/docs/source/telegram.businessopeninghours.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BusinessOpeningHours +==================== + +.. currentmodule:: telegram + +.. autoclass:: BusinessOpeningHours + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.businessopeninghoursinterval.rst b/docs/source/telegram.businessopeninghoursinterval.rst new file mode 100644 index 00000000000..3c0cf5133ea --- /dev/null +++ b/docs/source/telegram.businessopeninghoursinterval.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BusinessOpeningHoursInterval +============================ + +.. currentmodule:: telegram + +.. autoclass:: BusinessOpeningHoursInterval + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.callbackgame.rst b/docs/source/telegram.callbackgame.rst new file mode 100644 index 00000000000..6d9779f07cf --- /dev/null +++ b/docs/source/telegram.callbackgame.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +CallbackGame +============ + +.. currentmodule:: telegram + +.. autoclass:: CallbackGame + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.callbackquery.rst b/docs/source/telegram.callbackquery.rst new file mode 100644 index 00000000000..c622f0a3386 --- /dev/null +++ b/docs/source/telegram.callbackquery.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +CallbackQuery +============= + +.. currentmodule:: telegram + +.. autoclass:: CallbackQuery + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chat.rst b/docs/source/telegram.chat.rst new file mode 100644 index 00000000000..df483b4038c --- /dev/null +++ b/docs/source/telegram.chat.rst @@ -0,0 +1,3 @@ +.. Autogenerated page: True + +.. include:: telegram/chat.rst diff --git a/docs/source/telegram.chatadministratorrights.rst b/docs/source/telegram.chatadministratorrights.rst new file mode 100644 index 00000000000..84ccd9e524e --- /dev/null +++ b/docs/source/telegram.chatadministratorrights.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatAdministratorRights +======================= + +.. currentmodule:: telegram + +.. autoclass:: ChatAdministratorRights + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatbackground.rst b/docs/source/telegram.chatbackground.rst new file mode 100644 index 00000000000..c9338134e65 --- /dev/null +++ b/docs/source/telegram.chatbackground.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatBackground +============== + +.. currentmodule:: telegram + +.. autoclass:: ChatBackground + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboost.rst b/docs/source/telegram.chatboost.rst new file mode 100644 index 00000000000..1e055430658 --- /dev/null +++ b/docs/source/telegram.chatboost.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatBoost +========= + +.. currentmodule:: telegram + +.. autoclass:: ChatBoost + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostadded.rst b/docs/source/telegram.chatboostadded.rst new file mode 100644 index 00000000000..ee16a8691a1 --- /dev/null +++ b/docs/source/telegram.chatboostadded.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatBoostAdded +============== + +.. currentmodule:: telegram + +.. autoclass:: ChatBoostAdded + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostremoved.rst b/docs/source/telegram.chatboostremoved.rst new file mode 100644 index 00000000000..776eb995cda --- /dev/null +++ b/docs/source/telegram.chatboostremoved.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatBoostRemoved +================ + +.. currentmodule:: telegram + +.. autoclass:: ChatBoostRemoved + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostsource.rst b/docs/source/telegram.chatboostsource.rst new file mode 100644 index 00000000000..189ac7bcb7b --- /dev/null +++ b/docs/source/telegram.chatboostsource.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatBoostSource +=============== + +.. currentmodule:: telegram + +.. autoclass:: ChatBoostSource + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostsourcegiftcode.rst b/docs/source/telegram.chatboostsourcegiftcode.rst new file mode 100644 index 00000000000..e7eb4e6a483 --- /dev/null +++ b/docs/source/telegram.chatboostsourcegiftcode.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatBoostSourceGiftCode +======================= + +.. currentmodule:: telegram + +.. autoclass:: ChatBoostSourceGiftCode + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostsourcegiveaway.rst b/docs/source/telegram.chatboostsourcegiveaway.rst new file mode 100644 index 00000000000..f6caf38807a --- /dev/null +++ b/docs/source/telegram.chatboostsourcegiveaway.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatBoostSourceGiveaway +======================= + +.. currentmodule:: telegram + +.. autoclass:: ChatBoostSourceGiveaway + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostsourcepremium.rst b/docs/source/telegram.chatboostsourcepremium.rst new file mode 100644 index 00000000000..d81378c4039 --- /dev/null +++ b/docs/source/telegram.chatboostsourcepremium.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatBoostSourcePremium +====================== + +.. currentmodule:: telegram + +.. autoclass:: ChatBoostSourcePremium + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatboostupdated.rst b/docs/source/telegram.chatboostupdated.rst new file mode 100644 index 00000000000..9481ed8a6c5 --- /dev/null +++ b/docs/source/telegram.chatboostupdated.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatBoostUpdated +================ + +.. currentmodule:: telegram + +.. autoclass:: ChatBoostUpdated + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatfullinfo.rst b/docs/source/telegram.chatfullinfo.rst new file mode 100644 index 00000000000..93bd891d5a9 --- /dev/null +++ b/docs/source/telegram.chatfullinfo.rst @@ -0,0 +1,3 @@ +.. Autogenerated page: True + +.. include:: telegram/chatfullinfo.rst diff --git a/docs/source/telegram.chatinvitelink.rst b/docs/source/telegram.chatinvitelink.rst new file mode 100644 index 00000000000..7b4366e3224 --- /dev/null +++ b/docs/source/telegram.chatinvitelink.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatInviteLink +============== + +.. currentmodule:: telegram + +.. autoclass:: ChatInviteLink + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatjoinrequest.rst b/docs/source/telegram.chatjoinrequest.rst new file mode 100644 index 00000000000..e2ab2700aaf --- /dev/null +++ b/docs/source/telegram.chatjoinrequest.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatJoinRequest +=============== + +.. currentmodule:: telegram + +.. autoclass:: ChatJoinRequest + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatlocation.rst b/docs/source/telegram.chatlocation.rst new file mode 100644 index 00000000000..bbbd5edc16e --- /dev/null +++ b/docs/source/telegram.chatlocation.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatLocation +============ + +.. currentmodule:: telegram + +.. autoclass:: ChatLocation + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmember.rst b/docs/source/telegram.chatmember.rst new file mode 100644 index 00000000000..2e9a8e67a4b --- /dev/null +++ b/docs/source/telegram.chatmember.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatMember +========== + +.. currentmodule:: telegram + +.. autoclass:: ChatMember + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmemberadministrator.rst b/docs/source/telegram.chatmemberadministrator.rst new file mode 100644 index 00000000000..6d29520fb72 --- /dev/null +++ b/docs/source/telegram.chatmemberadministrator.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatMemberAdministrator +======================= + +.. currentmodule:: telegram + +.. autoclass:: ChatMemberAdministrator + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmemberbanned.rst b/docs/source/telegram.chatmemberbanned.rst new file mode 100644 index 00000000000..97d2c99e127 --- /dev/null +++ b/docs/source/telegram.chatmemberbanned.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatMemberBanned +================ + +.. currentmodule:: telegram + +.. autoclass:: ChatMemberBanned + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmemberleft.rst b/docs/source/telegram.chatmemberleft.rst new file mode 100644 index 00000000000..fcaf2ec725d --- /dev/null +++ b/docs/source/telegram.chatmemberleft.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatMemberLeft +============== + +.. currentmodule:: telegram + +.. autoclass:: ChatMemberLeft + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmembermember.rst b/docs/source/telegram.chatmembermember.rst new file mode 100644 index 00000000000..9cee283bb88 --- /dev/null +++ b/docs/source/telegram.chatmembermember.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatMemberMember +================ + +.. currentmodule:: telegram + +.. autoclass:: ChatMemberMember + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmemberowner.rst b/docs/source/telegram.chatmemberowner.rst new file mode 100644 index 00000000000..cf11128b7f9 --- /dev/null +++ b/docs/source/telegram.chatmemberowner.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatMemberOwner +=============== + +.. currentmodule:: telegram + +.. autoclass:: ChatMemberOwner + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmemberrestricted.rst b/docs/source/telegram.chatmemberrestricted.rst new file mode 100644 index 00000000000..4eadf9c4cde --- /dev/null +++ b/docs/source/telegram.chatmemberrestricted.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatMemberRestricted +==================== + +.. currentmodule:: telegram + +.. autoclass:: ChatMemberRestricted + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatmemberupdated.rst b/docs/source/telegram.chatmemberupdated.rst new file mode 100644 index 00000000000..91d9f10c965 --- /dev/null +++ b/docs/source/telegram.chatmemberupdated.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatMemberUpdated +================= + +.. currentmodule:: telegram + +.. autoclass:: ChatMemberUpdated + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatownerchanged.rst b/docs/source/telegram.chatownerchanged.rst new file mode 100644 index 00000000000..7864e8e1b9f --- /dev/null +++ b/docs/source/telegram.chatownerchanged.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatOwnerChanged +================ + +.. currentmodule:: telegram + +.. autoclass:: ChatOwnerChanged + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatownerleft.rst b/docs/source/telegram.chatownerleft.rst new file mode 100644 index 00000000000..79ab3bb18f2 --- /dev/null +++ b/docs/source/telegram.chatownerleft.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatOwnerLeft +============= + +.. currentmodule:: telegram + +.. autoclass:: ChatOwnerLeft + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatpermissions.rst b/docs/source/telegram.chatpermissions.rst new file mode 100644 index 00000000000..b4466565896 --- /dev/null +++ b/docs/source/telegram.chatpermissions.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatPermissions +=============== + +.. currentmodule:: telegram + +.. autoclass:: ChatPermissions + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatphoto.rst b/docs/source/telegram.chatphoto.rst new file mode 100644 index 00000000000..fcbe9707ed6 --- /dev/null +++ b/docs/source/telegram.chatphoto.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatPhoto +========= + +.. currentmodule:: telegram + +.. autoclass:: ChatPhoto + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.chatshared.rst b/docs/source/telegram.chatshared.rst new file mode 100644 index 00000000000..70a6f95bdc9 --- /dev/null +++ b/docs/source/telegram.chatshared.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatShared +========== + +.. currentmodule:: telegram + +.. autoclass:: ChatShared + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.checklist.rst b/docs/source/telegram.checklist.rst new file mode 100644 index 00000000000..8be79d85ead --- /dev/null +++ b/docs/source/telegram.checklist.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Checklist +========= + +.. currentmodule:: telegram + +.. autoclass:: Checklist + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.checklisttask.rst b/docs/source/telegram.checklisttask.rst new file mode 100644 index 00000000000..77e5bf73aa6 --- /dev/null +++ b/docs/source/telegram.checklisttask.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChecklistTask +============= + +.. currentmodule:: telegram + +.. autoclass:: ChecklistTask + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.checklisttasksadded.rst b/docs/source/telegram.checklisttasksadded.rst new file mode 100644 index 00000000000..f575b27b417 --- /dev/null +++ b/docs/source/telegram.checklisttasksadded.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChecklistTasksAdded +=================== + +.. currentmodule:: telegram + +.. autoclass:: ChecklistTasksAdded + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.checklisttasksdone.rst b/docs/source/telegram.checklisttasksdone.rst new file mode 100644 index 00000000000..fe6a8eeaf28 --- /dev/null +++ b/docs/source/telegram.checklisttasksdone.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChecklistTasksDone +================== + +.. currentmodule:: telegram + +.. autoclass:: ChecklistTasksDone + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.choseninlineresult.rst b/docs/source/telegram.choseninlineresult.rst new file mode 100644 index 00000000000..25f0979eeae --- /dev/null +++ b/docs/source/telegram.choseninlineresult.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChosenInlineResult +================== + +.. currentmodule:: telegram + +.. autoclass:: ChosenInlineResult + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.constants.rst b/docs/source/telegram.constants.rst index 618b35246f1..4ee00be0d45 100644 --- a/docs/source/telegram.constants.rst +++ b/docs/source/telegram.constants.rst @@ -1,8 +1,3 @@ -telegram.constants Module -========================= +.. Autogenerated page: True -.. automodule:: telegram.constants - :members: - :show-inheritance: - :no-undoc-members: - :exclude-members: __format__, __new__, __repr__, __str__ +.. include:: telegram/constants.rst diff --git a/docs/source/telegram.contact.rst b/docs/source/telegram.contact.rst new file mode 100644 index 00000000000..d1466e4b7db --- /dev/null +++ b/docs/source/telegram.contact.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Contact +======= + +.. currentmodule:: telegram + +.. autoclass:: Contact + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.copytextbutton.rst b/docs/source/telegram.copytextbutton.rst new file mode 100644 index 00000000000..08af180b14f --- /dev/null +++ b/docs/source/telegram.copytextbutton.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +CopyTextButton +============== + +.. currentmodule:: telegram + +.. autoclass:: CopyTextButton + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.credentials.rst b/docs/source/telegram.credentials.rst new file mode 100644 index 00000000000..2ab700df2ec --- /dev/null +++ b/docs/source/telegram.credentials.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Credentials +=========== + +.. currentmodule:: telegram + +.. autoclass:: Credentials + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.datacredentials.rst b/docs/source/telegram.datacredentials.rst new file mode 100644 index 00000000000..72f6f639327 --- /dev/null +++ b/docs/source/telegram.datacredentials.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +DataCredentials +=============== + +.. currentmodule:: telegram + +.. autoclass:: DataCredentials + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.dice.rst b/docs/source/telegram.dice.rst new file mode 100644 index 00000000000..6b5db896628 --- /dev/null +++ b/docs/source/telegram.dice.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Dice +==== + +.. currentmodule:: telegram + +.. autoclass:: Dice + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.directmessagepricechanged.rst b/docs/source/telegram.directmessagepricechanged.rst new file mode 100644 index 00000000000..37abc4def6e --- /dev/null +++ b/docs/source/telegram.directmessagepricechanged.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +DirectMessagePriceChanged +========================= + +.. currentmodule:: telegram + +.. autoclass:: DirectMessagePriceChanged + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.directmessagestopic.rst b/docs/source/telegram.directmessagestopic.rst new file mode 100644 index 00000000000..a7ba911696e --- /dev/null +++ b/docs/source/telegram.directmessagestopic.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +DirectMessagesTopic +=================== + +.. currentmodule:: telegram + +.. autoclass:: DirectMessagesTopic + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.document.rst b/docs/source/telegram.document.rst new file mode 100644 index 00000000000..f5454c82710 --- /dev/null +++ b/docs/source/telegram.document.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Document +======== + +.. currentmodule:: telegram + +.. autoclass:: Document + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.encryptedcredentials.rst b/docs/source/telegram.encryptedcredentials.rst new file mode 100644 index 00000000000..234e85738b9 --- /dev/null +++ b/docs/source/telegram.encryptedcredentials.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +EncryptedCredentials +==================== + +.. currentmodule:: telegram + +.. autoclass:: EncryptedCredentials + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.encryptedpassportelement.rst b/docs/source/telegram.encryptedpassportelement.rst new file mode 100644 index 00000000000..6930aa8d027 --- /dev/null +++ b/docs/source/telegram.encryptedpassportelement.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +EncryptedPassportElement +======================== + +.. currentmodule:: telegram + +.. autoclass:: EncryptedPassportElement + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.error.rst b/docs/source/telegram.error.rst index c5cd7aee0de..2ba25a41be2 100644 --- a/docs/source/telegram.error.rst +++ b/docs/source/telegram.error.rst @@ -1,6 +1,3 @@ -telegram.error Module -===================== +.. Autogenerated page: True -.. automodule:: telegram.error - :members: - :show-inheritance: +.. include:: telegram/error.rst diff --git a/docs/source/telegram.ext.acd-tree.rst b/docs/source/telegram.ext.acd-tree.rst index 0ce4efda72c..8f407b9bc6a 100644 --- a/docs/source/telegram.ext.acd-tree.rst +++ b/docs/source/telegram.ext.acd-tree.rst @@ -1,8 +1,6 @@ -Arbitrary Callback Data ------------------------ +.. Autogenerated page: True -.. toctree:: - :titlesonly: +.. _acd-tree: - telegram.ext.callbackdatacache - telegram.ext.invalidcallbackdata +Arbitrary Callback Data +----------------------- diff --git a/docs/source/telegram.ext.aioratelimiter.rst b/docs/source/telegram.ext.aioratelimiter.rst new file mode 100644 index 00000000000..be0e1a8a26b --- /dev/null +++ b/docs/source/telegram.ext.aioratelimiter.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +AIORateLimiter +============== + +.. currentmodule:: telegram.ext + +.. autoclass:: AIORateLimiter + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.application.rst b/docs/source/telegram.ext.application.rst new file mode 100644 index 00000000000..6099cbfbc88 --- /dev/null +++ b/docs/source/telegram.ext.application.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Application +=========== + +.. currentmodule:: telegram.ext + +.. autoclass:: Application + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.applicationbuilder.rst b/docs/source/telegram.ext.applicationbuilder.rst new file mode 100644 index 00000000000..3ed17141482 --- /dev/null +++ b/docs/source/telegram.ext.applicationbuilder.rst @@ -0,0 +1,3 @@ +.. Autogenerated page: True + +.. include:: telegram/ext/applicationbuilder.rst diff --git a/docs/source/telegram.ext.applicationhandlerstop.rst b/docs/source/telegram.ext.applicationhandlerstop.rst new file mode 100644 index 00000000000..cd67ac4b8b0 --- /dev/null +++ b/docs/source/telegram.ext.applicationhandlerstop.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ApplicationHandlerStop +====================== + +.. currentmodule:: telegram.ext + +.. autoexception:: ApplicationHandlerStop + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.basehandler.rst b/docs/source/telegram.ext.basehandler.rst new file mode 100644 index 00000000000..29853a1c6fe --- /dev/null +++ b/docs/source/telegram.ext.basehandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BaseHandler +=========== + +.. currentmodule:: telegram.ext + +.. autoclass:: BaseHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.basepersistence.rst b/docs/source/telegram.ext.basepersistence.rst new file mode 100644 index 00000000000..593a39080c0 --- /dev/null +++ b/docs/source/telegram.ext.basepersistence.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BasePersistence +=============== + +.. currentmodule:: telegram.ext + +.. autoclass:: BasePersistence + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.baseratelimiter.rst b/docs/source/telegram.ext.baseratelimiter.rst new file mode 100644 index 00000000000..192139062d6 --- /dev/null +++ b/docs/source/telegram.ext.baseratelimiter.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BaseRateLimiter +=============== + +.. currentmodule:: telegram.ext + +.. autoclass:: BaseRateLimiter + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.baseupdateprocessor.rst b/docs/source/telegram.ext.baseupdateprocessor.rst new file mode 100644 index 00000000000..c2a2f4dceea --- /dev/null +++ b/docs/source/telegram.ext.baseupdateprocessor.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BaseUpdateProcessor +=================== + +.. currentmodule:: telegram.ext + +.. autoclass:: BaseUpdateProcessor + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.businessconnectionhandler.rst b/docs/source/telegram.ext.businessconnectionhandler.rst new file mode 100644 index 00000000000..742c81d1727 --- /dev/null +++ b/docs/source/telegram.ext.businessconnectionhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BusinessConnectionHandler +========================= + +.. currentmodule:: telegram.ext + +.. autoclass:: BusinessConnectionHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.businessmessagesdeletedhandler.rst b/docs/source/telegram.ext.businessmessagesdeletedhandler.rst new file mode 100644 index 00000000000..bcd78b68700 --- /dev/null +++ b/docs/source/telegram.ext.businessmessagesdeletedhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BusinessMessagesDeletedHandler +============================== + +.. currentmodule:: telegram.ext + +.. autoclass:: BusinessMessagesDeletedHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.callbackcontext.rst b/docs/source/telegram.ext.callbackcontext.rst new file mode 100644 index 00000000000..b608121d43a --- /dev/null +++ b/docs/source/telegram.ext.callbackcontext.rst @@ -0,0 +1,3 @@ +.. Autogenerated page: True + +.. include:: telegram/ext/callbackcontext.rst diff --git a/docs/source/telegram.ext.callbackdatacache.rst b/docs/source/telegram.ext.callbackdatacache.rst new file mode 100644 index 00000000000..7d24170315f --- /dev/null +++ b/docs/source/telegram.ext.callbackdatacache.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +CallbackDataCache +================= + +.. currentmodule:: telegram.ext + +.. autoclass:: CallbackDataCache + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.callbackqueryhandler.rst b/docs/source/telegram.ext.callbackqueryhandler.rst new file mode 100644 index 00000000000..ba08e56700f --- /dev/null +++ b/docs/source/telegram.ext.callbackqueryhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +CallbackQueryHandler +==================== + +.. currentmodule:: telegram.ext + +.. autoclass:: CallbackQueryHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.chatboosthandler.rst b/docs/source/telegram.ext.chatboosthandler.rst new file mode 100644 index 00000000000..dbeded1592b --- /dev/null +++ b/docs/source/telegram.ext.chatboosthandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatBoostHandler +================ + +.. currentmodule:: telegram.ext + +.. autoclass:: ChatBoostHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.chatjoinrequesthandler.rst b/docs/source/telegram.ext.chatjoinrequesthandler.rst new file mode 100644 index 00000000000..01ea4b1a341 --- /dev/null +++ b/docs/source/telegram.ext.chatjoinrequesthandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatJoinRequestHandler +====================== + +.. currentmodule:: telegram.ext + +.. autoclass:: ChatJoinRequestHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.chatmemberhandler.rst b/docs/source/telegram.ext.chatmemberhandler.rst new file mode 100644 index 00000000000..47c93c6dfa6 --- /dev/null +++ b/docs/source/telegram.ext.chatmemberhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChatMemberHandler +================= + +.. currentmodule:: telegram.ext + +.. autoclass:: ChatMemberHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.choseninlineresulthandler.rst b/docs/source/telegram.ext.choseninlineresulthandler.rst new file mode 100644 index 00000000000..f8f8074bbd7 --- /dev/null +++ b/docs/source/telegram.ext.choseninlineresulthandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ChosenInlineResultHandler +========================= + +.. currentmodule:: telegram.ext + +.. autoclass:: ChosenInlineResultHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.commandhandler.rst b/docs/source/telegram.ext.commandhandler.rst new file mode 100644 index 00000000000..f00d457c11a --- /dev/null +++ b/docs/source/telegram.ext.commandhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +CommandHandler +============== + +.. currentmodule:: telegram.ext + +.. autoclass:: CommandHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.contexttypes.rst b/docs/source/telegram.ext.contexttypes.rst new file mode 100644 index 00000000000..0a5cb44a50e --- /dev/null +++ b/docs/source/telegram.ext.contexttypes.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ContextTypes +============ + +.. currentmodule:: telegram.ext + +.. autoclass:: ContextTypes + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.conversationhandler.rst b/docs/source/telegram.ext.conversationhandler.rst new file mode 100644 index 00000000000..ae57dd0f883 --- /dev/null +++ b/docs/source/telegram.ext.conversationhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ConversationHandler +=================== + +.. currentmodule:: telegram.ext + +.. autoclass:: ConversationHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.defaults.rst b/docs/source/telegram.ext.defaults.rst new file mode 100644 index 00000000000..b02fc22ce35 --- /dev/null +++ b/docs/source/telegram.ext.defaults.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Defaults +======== + +.. currentmodule:: telegram.ext + +.. autoclass:: Defaults + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.dictpersistence.rst b/docs/source/telegram.ext.dictpersistence.rst new file mode 100644 index 00000000000..73bbdae7eef --- /dev/null +++ b/docs/source/telegram.ext.dictpersistence.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +DictPersistence +=============== + +.. currentmodule:: telegram.ext + +.. autoclass:: DictPersistence + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.extbot.rst b/docs/source/telegram.ext.extbot.rst new file mode 100644 index 00000000000..395e29e630e --- /dev/null +++ b/docs/source/telegram.ext.extbot.rst @@ -0,0 +1,3 @@ +.. Autogenerated page: True + +.. include:: telegram/ext/extbot.rst diff --git a/docs/source/telegram.ext.filters.rst b/docs/source/telegram.ext.filters.rst index 7762ab01036..db01bdb2fd5 100644 --- a/docs/source/telegram.ext.filters.rst +++ b/docs/source/telegram.ext.filters.rst @@ -1,11 +1,3 @@ -filters Module -============== +.. Autogenerated page: True -.. :bysource: since e.g filters.CHAT is much above filters.Chat() in the docs when it shouldn't. - The classes in `filters.py` are sorted alphabetically such that :bysource: still is readable - -.. automodule:: telegram.ext.filters - :inherited-members: BaseFilter, MessageFilter, UpdateFilter, object - :members: - :show-inheritance: - :member-order: bysource \ No newline at end of file +.. include:: telegram/ext/filters.rst diff --git a/docs/source/telegram.ext.handlers-tree.rst b/docs/source/telegram.ext.handlers-tree.rst index 690aca1c537..01b34834536 100644 --- a/docs/source/telegram.ext.handlers-tree.rst +++ b/docs/source/telegram.ext.handlers-tree.rst @@ -1,30 +1,6 @@ -Handlers --------- +.. Autogenerated page: True -.. toctree:: - :titlesonly: +.. _handlers-tree: - telegram.ext.basehandler - telegram.ext.businessconnectionhandler - telegram.ext.businessmessagesdeletedhandler - telegram.ext.callbackqueryhandler - telegram.ext.chatboosthandler - telegram.ext.chatjoinrequesthandler - telegram.ext.chatmemberhandler - telegram.ext.choseninlineresulthandler - telegram.ext.commandhandler - telegram.ext.conversationhandler - telegram.ext.filters - telegram.ext.inlinequeryhandler - telegram.ext.managedbotupdatedhandler - telegram.ext.messagehandler - telegram.ext.messagereactionhandler - telegram.ext.paidmediapurchasedhandler - telegram.ext.pollanswerhandler - telegram.ext.pollhandler - telegram.ext.precheckoutqueryhandler - telegram.ext.prefixhandler - telegram.ext.shippingqueryhandler - telegram.ext.stringcommandhandler - telegram.ext.stringregexhandler - telegram.ext.typehandler +Handlers +-------- diff --git a/docs/source/telegram.ext.inlinequeryhandler.rst b/docs/source/telegram.ext.inlinequeryhandler.rst new file mode 100644 index 00000000000..7deddb5f320 --- /dev/null +++ b/docs/source/telegram.ext.inlinequeryhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryHandler +================== + +.. currentmodule:: telegram.ext + +.. autoclass:: InlineQueryHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.invalidcallbackdata.rst b/docs/source/telegram.ext.invalidcallbackdata.rst new file mode 100644 index 00000000000..5363fb6a294 --- /dev/null +++ b/docs/source/telegram.ext.invalidcallbackdata.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InvalidCallbackData +=================== + +.. currentmodule:: telegram.ext + +.. autoexception:: InvalidCallbackData + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.job.rst b/docs/source/telegram.ext.job.rst new file mode 100644 index 00000000000..bdaeb990c79 --- /dev/null +++ b/docs/source/telegram.ext.job.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Job +=== + +.. currentmodule:: telegram.ext + +.. autoclass:: Job + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.jobqueue.rst b/docs/source/telegram.ext.jobqueue.rst new file mode 100644 index 00000000000..d84c4579a0d --- /dev/null +++ b/docs/source/telegram.ext.jobqueue.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +JobQueue +======== + +.. currentmodule:: telegram.ext + +.. autoclass:: JobQueue + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.managedbotupdatedhandler.rst b/docs/source/telegram.ext.managedbotupdatedhandler.rst new file mode 100644 index 00000000000..8575e979493 --- /dev/null +++ b/docs/source/telegram.ext.managedbotupdatedhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ManagedBotUpdatedHandler +======================== + +.. currentmodule:: telegram.ext + +.. autoclass:: ManagedBotUpdatedHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.messagehandler.rst b/docs/source/telegram.ext.messagehandler.rst new file mode 100644 index 00000000000..b609415a17b --- /dev/null +++ b/docs/source/telegram.ext.messagehandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MessageHandler +============== + +.. currentmodule:: telegram.ext + +.. autoclass:: MessageHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.messagereactionhandler.rst b/docs/source/telegram.ext.messagereactionhandler.rst new file mode 100644 index 00000000000..2b2a7f3bf2a --- /dev/null +++ b/docs/source/telegram.ext.messagereactionhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MessageReactionHandler +====================== + +.. currentmodule:: telegram.ext + +.. autoclass:: MessageReactionHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.paidmediapurchasedhandler.rst b/docs/source/telegram.ext.paidmediapurchasedhandler.rst new file mode 100644 index 00000000000..cc87452c18b --- /dev/null +++ b/docs/source/telegram.ext.paidmediapurchasedhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PaidMediaPurchasedHandler +========================= + +.. currentmodule:: telegram.ext + +.. autoclass:: PaidMediaPurchasedHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.persistence-tree.rst b/docs/source/telegram.ext.persistence-tree.rst index c17d7bd5555..3307f1f4fb5 100644 --- a/docs/source/telegram.ext.persistence-tree.rst +++ b/docs/source/telegram.ext.persistence-tree.rst @@ -1,10 +1,6 @@ -Persistence ------------ +.. Autogenerated page: True -.. toctree:: - :titlesonly: +.. _persistence-tree: - telegram.ext.basepersistence - telegram.ext.dictpersistence - telegram.ext.persistenceinput - telegram.ext.picklepersistence +Persistence +----------- diff --git a/docs/source/telegram.ext.persistenceinput.rst b/docs/source/telegram.ext.persistenceinput.rst new file mode 100644 index 00000000000..09e023a52c4 --- /dev/null +++ b/docs/source/telegram.ext.persistenceinput.rst @@ -0,0 +1,3 @@ +.. Autogenerated page: True + +.. include:: telegram/ext/persistenceinput.rst diff --git a/docs/source/telegram.ext.picklepersistence.rst b/docs/source/telegram.ext.picklepersistence.rst new file mode 100644 index 00000000000..0e62ecc6ac1 --- /dev/null +++ b/docs/source/telegram.ext.picklepersistence.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PicklePersistence +================= + +.. currentmodule:: telegram.ext + +.. autoclass:: PicklePersistence + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.pollanswerhandler.rst b/docs/source/telegram.ext.pollanswerhandler.rst new file mode 100644 index 00000000000..17f1fb67133 --- /dev/null +++ b/docs/source/telegram.ext.pollanswerhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PollAnswerHandler +================= + +.. currentmodule:: telegram.ext + +.. autoclass:: PollAnswerHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.pollhandler.rst b/docs/source/telegram.ext.pollhandler.rst new file mode 100644 index 00000000000..1e59f535b70 --- /dev/null +++ b/docs/source/telegram.ext.pollhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PollHandler +=========== + +.. currentmodule:: telegram.ext + +.. autoclass:: PollHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.precheckoutqueryhandler.rst b/docs/source/telegram.ext.precheckoutqueryhandler.rst new file mode 100644 index 00000000000..4b98f1bed2f --- /dev/null +++ b/docs/source/telegram.ext.precheckoutqueryhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PreCheckoutQueryHandler +======================= + +.. currentmodule:: telegram.ext + +.. autoclass:: PreCheckoutQueryHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.prefixhandler.rst b/docs/source/telegram.ext.prefixhandler.rst new file mode 100644 index 00000000000..13ef3389f61 --- /dev/null +++ b/docs/source/telegram.ext.prefixhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PrefixHandler +============= + +.. currentmodule:: telegram.ext + +.. autoclass:: PrefixHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.rate-limiting-tree.rst b/docs/source/telegram.ext.rate-limiting-tree.rst index 023a3a633c5..4fa343eec74 100644 --- a/docs/source/telegram.ext.rate-limiting-tree.rst +++ b/docs/source/telegram.ext.rate-limiting-tree.rst @@ -1,8 +1,6 @@ -Rate Limiting -------------- +.. Autogenerated page: True -.. toctree:: - :titlesonly: +.. _rate-limiting-tree: - telegram.ext.baseratelimiter - telegram.ext.aioratelimiter \ No newline at end of file +Rate Limiting +------------- diff --git a/docs/source/telegram.ext.rst b/docs/source/telegram.ext.rst index 37642a4e18c..596d1e20327 100644 --- a/docs/source/telegram.ext.rst +++ b/docs/source/telegram.ext.rst @@ -1,6 +1,3 @@ -telegram.ext package -==================== +.. Autogenerated page: True -.. automodule:: telegram.ext - -.. ptb-api-toctree:: ext +.. include:: telegram/ext/index.rst diff --git a/docs/source/telegram.ext.shippingqueryhandler.rst b/docs/source/telegram.ext.shippingqueryhandler.rst new file mode 100644 index 00000000000..9ddff31010a --- /dev/null +++ b/docs/source/telegram.ext.shippingqueryhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ShippingQueryHandler +==================== + +.. currentmodule:: telegram.ext + +.. autoclass:: ShippingQueryHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.simpleupdateprocessor.rst b/docs/source/telegram.ext.simpleupdateprocessor.rst new file mode 100644 index 00000000000..3bba89c3992 --- /dev/null +++ b/docs/source/telegram.ext.simpleupdateprocessor.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SimpleUpdateProcessor +===================== + +.. currentmodule:: telegram.ext + +.. autoclass:: SimpleUpdateProcessor + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.stringcommandhandler.rst b/docs/source/telegram.ext.stringcommandhandler.rst new file mode 100644 index 00000000000..1647c519180 --- /dev/null +++ b/docs/source/telegram.ext.stringcommandhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +StringCommandHandler +==================== + +.. currentmodule:: telegram.ext + +.. autoclass:: StringCommandHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.stringregexhandler.rst b/docs/source/telegram.ext.stringregexhandler.rst new file mode 100644 index 00000000000..2b1eec653cf --- /dev/null +++ b/docs/source/telegram.ext.stringregexhandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +StringRegexHandler +================== + +.. currentmodule:: telegram.ext + +.. autoclass:: StringRegexHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.typehandler.rst b/docs/source/telegram.ext.typehandler.rst new file mode 100644 index 00000000000..b8097a49ef5 --- /dev/null +++ b/docs/source/telegram.ext.typehandler.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +TypeHandler +=========== + +.. currentmodule:: telegram.ext + +.. autoclass:: TypeHandler + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.updater.rst b/docs/source/telegram.ext.updater.rst new file mode 100644 index 00000000000..a2f24a67706 --- /dev/null +++ b/docs/source/telegram.ext.updater.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Updater +======= + +.. currentmodule:: telegram.ext + +.. autoclass:: Updater + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.externalreplyinfo.rst b/docs/source/telegram.externalreplyinfo.rst new file mode 100644 index 00000000000..acc2b1fa833 --- /dev/null +++ b/docs/source/telegram.externalreplyinfo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ExternalReplyInfo +================= + +.. currentmodule:: telegram + +.. autoclass:: ExternalReplyInfo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.file.rst b/docs/source/telegram.file.rst new file mode 100644 index 00000000000..a371b63255d --- /dev/null +++ b/docs/source/telegram.file.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +File +==== + +.. currentmodule:: telegram + +.. autoclass:: File + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.filecredentials.rst b/docs/source/telegram.filecredentials.rst new file mode 100644 index 00000000000..c8ad2e2c711 --- /dev/null +++ b/docs/source/telegram.filecredentials.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +FileCredentials +=============== + +.. currentmodule:: telegram + +.. autoclass:: FileCredentials + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.forcereply.rst b/docs/source/telegram.forcereply.rst new file mode 100644 index 00000000000..ca8d3f3a6d0 --- /dev/null +++ b/docs/source/telegram.forcereply.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ForceReply +========== + +.. currentmodule:: telegram + +.. autoclass:: ForceReply + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.forumtopic.rst b/docs/source/telegram.forumtopic.rst new file mode 100644 index 00000000000..c9e1d6fee66 --- /dev/null +++ b/docs/source/telegram.forumtopic.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ForumTopic +========== + +.. currentmodule:: telegram + +.. autoclass:: ForumTopic + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.forumtopicclosed.rst b/docs/source/telegram.forumtopicclosed.rst new file mode 100644 index 00000000000..c58d7ece2c8 --- /dev/null +++ b/docs/source/telegram.forumtopicclosed.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ForumTopicClosed +================ + +.. currentmodule:: telegram + +.. autoclass:: ForumTopicClosed + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.forumtopiccreated.rst b/docs/source/telegram.forumtopiccreated.rst new file mode 100644 index 00000000000..bae5d36e643 --- /dev/null +++ b/docs/source/telegram.forumtopiccreated.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ForumTopicCreated +================= + +.. currentmodule:: telegram + +.. autoclass:: ForumTopicCreated + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.forumtopicedited.rst b/docs/source/telegram.forumtopicedited.rst new file mode 100644 index 00000000000..8558192a876 --- /dev/null +++ b/docs/source/telegram.forumtopicedited.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ForumTopicEdited +================ + +.. currentmodule:: telegram + +.. autoclass:: ForumTopicEdited + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.forumtopicreopened.rst b/docs/source/telegram.forumtopicreopened.rst new file mode 100644 index 00000000000..d59faf1d020 --- /dev/null +++ b/docs/source/telegram.forumtopicreopened.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ForumTopicReopened +================== + +.. currentmodule:: telegram + +.. autoclass:: ForumTopicReopened + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.game.rst b/docs/source/telegram.game.rst new file mode 100644 index 00000000000..8d63e397b7b --- /dev/null +++ b/docs/source/telegram.game.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Game +==== + +.. currentmodule:: telegram + +.. autoclass:: Game + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.gamehighscore.rst b/docs/source/telegram.gamehighscore.rst new file mode 100644 index 00000000000..1eab394280d --- /dev/null +++ b/docs/source/telegram.gamehighscore.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +GameHighScore +============= + +.. currentmodule:: telegram + +.. autoclass:: GameHighScore + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.games-tree.rst b/docs/source/telegram.games-tree.rst index 97b961a9e85..6eb3fb04d9e 100644 --- a/docs/source/telegram.games-tree.rst +++ b/docs/source/telegram.games-tree.rst @@ -1,24 +1,6 @@ +.. Autogenerated page: True + .. _games-tree: Games ----- - -Your bot can offer users **HTML5 games** to play solo or to compete against each other in groups and one-on-one chats. Create games via `@BotFather `_ using the ``/newgame`` command. Please note that this kind of power requires responsibility: you will need to accept the terms for each game that your bots will be offering. - -* Games are a new type of content on Telegram, represented by the :class:`telegram.Game` and :class:`telegram.InlineQueryResultGame` objects. -* Once you've created a game via `BotFather `_, you can send games to chats as regular messages using the :meth:`~telegram.Bot.sendGame` method, or use :ref:`inline mode ` with :class:`telegram.InlineQueryResultGame`. -* If you send the game message without any buttons, it will automatically have a 'Play ``GameName``' button. When this button is pressed, your bot gets a :class:`telegram.CallbackQuery` with the ``game_short_name`` of the requested game. You provide the correct URL for this particular user and the app opens the game in the in-app browser. -* You can manually add multiple buttons to your game message. Please note that the first button in the first row **must always** launch the game, using the field ``callback_game`` in :class:`telegram.InlineKeyboardButton`. You can add extra buttons according to taste: e.g., for a description of the rules, or to open the game's official community. -* To make your game more attractive, you can upload a GIF animation that demonstrates the game to the users via `BotFather `_ (see `Lumberjack `_ for example). -* A game message will also display high scores for the current chat. Use :meth:`~telegram.Bot.setGameScore` to post high scores to the chat with the game, add the :paramref:`~telegram.Bot.set_game_score.disable_edit_message` parameter to disable automatic update of the message with the current scoreboard. -* Use :meth:`~telegram.Bot.getGameHighScores` to get data for in-game high score tables. -* You can also add an extra sharing button for users to share their best score to different chats. -* For examples of what can be done using this new stuff, check the `@gamebot `_ and `@gamee `_ bots. - - -.. toctree:: - :titlesonly: - - telegram.callbackgame - telegram.game - telegram.gamehighscore diff --git a/docs/source/telegram.generalforumtopichidden.rst b/docs/source/telegram.generalforumtopichidden.rst new file mode 100644 index 00000000000..5ab7ab47ebd --- /dev/null +++ b/docs/source/telegram.generalforumtopichidden.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +GeneralForumTopicHidden +======================= + +.. currentmodule:: telegram + +.. autoclass:: GeneralForumTopicHidden + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.generalforumtopicunhidden.rst b/docs/source/telegram.generalforumtopicunhidden.rst new file mode 100644 index 00000000000..9125917b840 --- /dev/null +++ b/docs/source/telegram.generalforumtopicunhidden.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +GeneralForumTopicUnhidden +========================= + +.. currentmodule:: telegram + +.. autoclass:: GeneralForumTopicUnhidden + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.gift.rst b/docs/source/telegram.gift.rst new file mode 100644 index 00000000000..0c343d090c7 --- /dev/null +++ b/docs/source/telegram.gift.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Gift +==== + +.. currentmodule:: telegram + +.. autoclass:: Gift + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giftbackground.rst b/docs/source/telegram.giftbackground.rst new file mode 100644 index 00000000000..bbc5bf04015 --- /dev/null +++ b/docs/source/telegram.giftbackground.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +GiftBackground +============== + +.. currentmodule:: telegram + +.. autoclass:: GiftBackground + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giftinfo.rst b/docs/source/telegram.giftinfo.rst new file mode 100644 index 00000000000..08fb58fba0f --- /dev/null +++ b/docs/source/telegram.giftinfo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +GiftInfo +======== + +.. currentmodule:: telegram + +.. autoclass:: GiftInfo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.gifts.rst b/docs/source/telegram.gifts.rst new file mode 100644 index 00000000000..6a8c1a8b5d4 --- /dev/null +++ b/docs/source/telegram.gifts.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Gifts +===== + +.. currentmodule:: telegram + +.. autoclass:: Gifts + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giveaway.rst b/docs/source/telegram.giveaway.rst new file mode 100644 index 00000000000..bb2ce325ac9 --- /dev/null +++ b/docs/source/telegram.giveaway.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Giveaway +======== + +.. currentmodule:: telegram + +.. autoclass:: Giveaway + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giveawaycompleted.rst b/docs/source/telegram.giveawaycompleted.rst new file mode 100644 index 00000000000..0ac849d019b --- /dev/null +++ b/docs/source/telegram.giveawaycompleted.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +GiveawayCompleted +================= + +.. currentmodule:: telegram + +.. autoclass:: GiveawayCompleted + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giveawaycreated.rst b/docs/source/telegram.giveawaycreated.rst new file mode 100644 index 00000000000..ef881bb72fd --- /dev/null +++ b/docs/source/telegram.giveawaycreated.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +GiveawayCreated +=============== + +.. currentmodule:: telegram + +.. autoclass:: GiveawayCreated + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.giveawaywinners.rst b/docs/source/telegram.giveawaywinners.rst new file mode 100644 index 00000000000..c52233349dd --- /dev/null +++ b/docs/source/telegram.giveawaywinners.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +GiveawayWinners +=============== + +.. currentmodule:: telegram + +.. autoclass:: GiveawayWinners + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.helpers.rst b/docs/source/telegram.helpers.rst index 7d589f3e346..044ec094859 100644 --- a/docs/source/telegram.helpers.rst +++ b/docs/source/telegram.helpers.rst @@ -1,6 +1,3 @@ -telegram.helpers Module -======================= +.. Autogenerated page: True -.. automodule:: telegram.helpers - :members: - :show-inheritance: +.. include:: telegram/helpers.rst diff --git a/docs/source/telegram.iddocumentdata.rst b/docs/source/telegram.iddocumentdata.rst new file mode 100644 index 00000000000..f0cf234c23c --- /dev/null +++ b/docs/source/telegram.iddocumentdata.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +IdDocumentData +============== + +.. currentmodule:: telegram + +.. autoclass:: IdDocumentData + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inaccessiblemessage.rst b/docs/source/telegram.inaccessiblemessage.rst new file mode 100644 index 00000000000..b94a650bcf9 --- /dev/null +++ b/docs/source/telegram.inaccessiblemessage.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InaccessibleMessage +=================== + +.. currentmodule:: telegram + +.. autoclass:: InaccessibleMessage + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inline-tree.rst b/docs/source/telegram.inline-tree.rst index c21b3c33828..bafca573f3c 100644 --- a/docs/source/telegram.inline-tree.rst +++ b/docs/source/telegram.inline-tree.rst @@ -1,45 +1,6 @@ +.. Autogenerated page: True + .. _inline-tree: Inline Mode ----------- - -The following methods and objects allow your bot to work in `inline mode `_. -Please see Telegrams `Introduction to Inline bots `_ for more details. - -To enable this option, send the ``/setinline`` command to `@BotFather `_ and provide the placeholder text that the user will see in the input field after typing your bot's name. - - -.. toctree:: - :titlesonly: - - telegram.choseninlineresult - 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.inlinequeryresultsbutton - telegram.inlinequeryresultvenue - telegram.inlinequeryresultvideo - telegram.inlinequeryresultvoice - telegram.inputmessagecontent - telegram.inputtextmessagecontent - telegram.inputlocationmessagecontent - telegram.inputvenuemessagecontent - telegram.inputcontactmessagecontent - telegram.inputinvoicemessagecontent - telegram.preparedinlinemessage diff --git a/docs/source/telegram.inlinekeyboardbutton.rst b/docs/source/telegram.inlinekeyboardbutton.rst new file mode 100644 index 00000000000..d15ee562d4d --- /dev/null +++ b/docs/source/telegram.inlinekeyboardbutton.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineKeyboardButton +==================== + +.. currentmodule:: telegram + +.. autoclass:: InlineKeyboardButton + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinekeyboardmarkup.rst b/docs/source/telegram.inlinekeyboardmarkup.rst new file mode 100644 index 00000000000..ec02dc44393 --- /dev/null +++ b/docs/source/telegram.inlinekeyboardmarkup.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineKeyboardMarkup +==================== + +.. currentmodule:: telegram + +.. autoclass:: InlineKeyboardMarkup + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequery.rst b/docs/source/telegram.inlinequery.rst new file mode 100644 index 00000000000..9430c7b15ad --- /dev/null +++ b/docs/source/telegram.inlinequery.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQuery +=========== + +.. currentmodule:: telegram + +.. autoclass:: InlineQuery + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresult.rst b/docs/source/telegram.inlinequeryresult.rst new file mode 100644 index 00000000000..ddd5092fb38 --- /dev/null +++ b/docs/source/telegram.inlinequeryresult.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResult +================= + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResult + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultarticle.rst b/docs/source/telegram.inlinequeryresultarticle.rst new file mode 100644 index 00000000000..c58a9265f1b --- /dev/null +++ b/docs/source/telegram.inlinequeryresultarticle.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultArticle +======================== + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultArticle + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultaudio.rst b/docs/source/telegram.inlinequeryresultaudio.rst new file mode 100644 index 00000000000..b54408546f0 --- /dev/null +++ b/docs/source/telegram.inlinequeryresultaudio.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultAudio +====================== + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultAudio + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcachedaudio.rst b/docs/source/telegram.inlinequeryresultcachedaudio.rst new file mode 100644 index 00000000000..eadecb2afc4 --- /dev/null +++ b/docs/source/telegram.inlinequeryresultcachedaudio.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultCachedAudio +============================ + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedAudio + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcacheddocument.rst b/docs/source/telegram.inlinequeryresultcacheddocument.rst new file mode 100644 index 00000000000..930fd0b5068 --- /dev/null +++ b/docs/source/telegram.inlinequeryresultcacheddocument.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultCachedDocument +=============================== + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedDocument + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcachedgif.rst b/docs/source/telegram.inlinequeryresultcachedgif.rst new file mode 100644 index 00000000000..75352cd6a32 --- /dev/null +++ b/docs/source/telegram.inlinequeryresultcachedgif.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultCachedGif +========================== + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedGif + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst b/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst new file mode 100644 index 00000000000..d07276c9f33 --- /dev/null +++ b/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultCachedMpeg4Gif +=============================== + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedMpeg4Gif + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcachedphoto.rst b/docs/source/telegram.inlinequeryresultcachedphoto.rst new file mode 100644 index 00000000000..6f06251f9e2 --- /dev/null +++ b/docs/source/telegram.inlinequeryresultcachedphoto.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultCachedPhoto +============================ + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedPhoto + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcachedsticker.rst b/docs/source/telegram.inlinequeryresultcachedsticker.rst new file mode 100644 index 00000000000..35b2e561c64 --- /dev/null +++ b/docs/source/telegram.inlinequeryresultcachedsticker.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultCachedSticker +============================== + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedSticker + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcachedvideo.rst b/docs/source/telegram.inlinequeryresultcachedvideo.rst new file mode 100644 index 00000000000..83debd172fd --- /dev/null +++ b/docs/source/telegram.inlinequeryresultcachedvideo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultCachedVideo +============================ + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedVideo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcachedvoice.rst b/docs/source/telegram.inlinequeryresultcachedvoice.rst new file mode 100644 index 00000000000..07b2f09500a --- /dev/null +++ b/docs/source/telegram.inlinequeryresultcachedvoice.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultCachedVoice +============================ + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultCachedVoice + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultcontact.rst b/docs/source/telegram.inlinequeryresultcontact.rst new file mode 100644 index 00000000000..025ce2d4d5e --- /dev/null +++ b/docs/source/telegram.inlinequeryresultcontact.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultContact +======================== + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultContact + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultdocument.rst b/docs/source/telegram.inlinequeryresultdocument.rst new file mode 100644 index 00000000000..eeb2105c12c --- /dev/null +++ b/docs/source/telegram.inlinequeryresultdocument.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultDocument +========================= + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultDocument + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultgame.rst b/docs/source/telegram.inlinequeryresultgame.rst new file mode 100644 index 00000000000..89228a19825 --- /dev/null +++ b/docs/source/telegram.inlinequeryresultgame.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultGame +===================== + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultGame + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultgif.rst b/docs/source/telegram.inlinequeryresultgif.rst new file mode 100644 index 00000000000..4d296b839cc --- /dev/null +++ b/docs/source/telegram.inlinequeryresultgif.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultGif +==================== + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultGif + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultlocation.rst b/docs/source/telegram.inlinequeryresultlocation.rst new file mode 100644 index 00000000000..cbcee96c04d --- /dev/null +++ b/docs/source/telegram.inlinequeryresultlocation.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultLocation +========================= + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultLocation + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultmpeg4gif.rst b/docs/source/telegram.inlinequeryresultmpeg4gif.rst new file mode 100644 index 00000000000..36dd1c8985a --- /dev/null +++ b/docs/source/telegram.inlinequeryresultmpeg4gif.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultMpeg4Gif +========================= + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultMpeg4Gif + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultphoto.rst b/docs/source/telegram.inlinequeryresultphoto.rst new file mode 100644 index 00000000000..5f24b70e867 --- /dev/null +++ b/docs/source/telegram.inlinequeryresultphoto.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultPhoto +====================== + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultPhoto + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultsbutton.rst b/docs/source/telegram.inlinequeryresultsbutton.rst new file mode 100644 index 00000000000..36b034f38f4 --- /dev/null +++ b/docs/source/telegram.inlinequeryresultsbutton.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultsButton +======================== + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultsButton + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultvenue.rst b/docs/source/telegram.inlinequeryresultvenue.rst new file mode 100644 index 00000000000..bcd89010140 --- /dev/null +++ b/docs/source/telegram.inlinequeryresultvenue.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultVenue +====================== + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultVenue + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultvideo.rst b/docs/source/telegram.inlinequeryresultvideo.rst new file mode 100644 index 00000000000..799d69db0ef --- /dev/null +++ b/docs/source/telegram.inlinequeryresultvideo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultVideo +====================== + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultVideo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inlinequeryresultvoice.rst b/docs/source/telegram.inlinequeryresultvoice.rst new file mode 100644 index 00000000000..20c14e0406e --- /dev/null +++ b/docs/source/telegram.inlinequeryresultvoice.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InlineQueryResultVoice +====================== + +.. currentmodule:: telegram + +.. autoclass:: InlineQueryResultVoice + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputchecklist.rst b/docs/source/telegram.inputchecklist.rst new file mode 100644 index 00000000000..8d7acaf336e --- /dev/null +++ b/docs/source/telegram.inputchecklist.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputChecklist +============== + +.. currentmodule:: telegram + +.. autoclass:: InputChecklist + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputchecklisttask.rst b/docs/source/telegram.inputchecklisttask.rst new file mode 100644 index 00000000000..2c02012bc90 --- /dev/null +++ b/docs/source/telegram.inputchecklisttask.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputChecklistTask +================== + +.. currentmodule:: telegram + +.. autoclass:: InputChecklistTask + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputcontactmessagecontent.rst b/docs/source/telegram.inputcontactmessagecontent.rst new file mode 100644 index 00000000000..94d58bd79c4 --- /dev/null +++ b/docs/source/telegram.inputcontactmessagecontent.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputContactMessageContent +========================== + +.. currentmodule:: telegram + +.. autoclass:: InputContactMessageContent + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputfile.rst b/docs/source/telegram.inputfile.rst new file mode 100644 index 00000000000..0afd886ccd0 --- /dev/null +++ b/docs/source/telegram.inputfile.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputFile +========= + +.. currentmodule:: telegram + +.. autoclass:: InputFile + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputinvoicemessagecontent.rst b/docs/source/telegram.inputinvoicemessagecontent.rst new file mode 100644 index 00000000000..cea1ffca1e8 --- /dev/null +++ b/docs/source/telegram.inputinvoicemessagecontent.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputInvoiceMessageContent +========================== + +.. currentmodule:: telegram + +.. autoclass:: InputInvoiceMessageContent + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputlocationmessagecontent.rst b/docs/source/telegram.inputlocationmessagecontent.rst new file mode 100644 index 00000000000..f0ea03bc822 --- /dev/null +++ b/docs/source/telegram.inputlocationmessagecontent.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputLocationMessageContent +=========================== + +.. currentmodule:: telegram + +.. autoclass:: InputLocationMessageContent + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmedia.rst b/docs/source/telegram.inputmedia.rst new file mode 100644 index 00000000000..c67a046c9e1 --- /dev/null +++ b/docs/source/telegram.inputmedia.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputMedia +========== + +.. currentmodule:: telegram + +.. autoclass:: InputMedia + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmediaanimation.rst b/docs/source/telegram.inputmediaanimation.rst new file mode 100644 index 00000000000..c6db3fef122 --- /dev/null +++ b/docs/source/telegram.inputmediaanimation.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputMediaAnimation +=================== + +.. currentmodule:: telegram + +.. autoclass:: InputMediaAnimation + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmediaaudio.rst b/docs/source/telegram.inputmediaaudio.rst new file mode 100644 index 00000000000..1e3c37f3ef2 --- /dev/null +++ b/docs/source/telegram.inputmediaaudio.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputMediaAudio +=============== + +.. currentmodule:: telegram + +.. autoclass:: InputMediaAudio + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmediadocument.rst b/docs/source/telegram.inputmediadocument.rst new file mode 100644 index 00000000000..c5381a3399b --- /dev/null +++ b/docs/source/telegram.inputmediadocument.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputMediaDocument +================== + +.. currentmodule:: telegram + +.. autoclass:: InputMediaDocument + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmedialivephoto.rst b/docs/source/telegram.inputmedialivephoto.rst new file mode 100644 index 00000000000..179f62c7614 --- /dev/null +++ b/docs/source/telegram.inputmedialivephoto.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputMediaLivePhoto +=================== + +.. currentmodule:: telegram + +.. autoclass:: InputMediaLivePhoto + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmedialocation.rst b/docs/source/telegram.inputmedialocation.rst new file mode 100644 index 00000000000..bc5a5abf728 --- /dev/null +++ b/docs/source/telegram.inputmedialocation.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputMediaLocation +================== + +.. currentmodule:: telegram + +.. autoclass:: InputMediaLocation + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmediaphoto.rst b/docs/source/telegram.inputmediaphoto.rst new file mode 100644 index 00000000000..e735a040b61 --- /dev/null +++ b/docs/source/telegram.inputmediaphoto.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputMediaPhoto +=============== + +.. currentmodule:: telegram + +.. autoclass:: InputMediaPhoto + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmediasticker.rst b/docs/source/telegram.inputmediasticker.rst new file mode 100644 index 00000000000..cfb70d3b376 --- /dev/null +++ b/docs/source/telegram.inputmediasticker.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputMediaSticker +================= + +.. currentmodule:: telegram + +.. autoclass:: InputMediaSticker + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmediavenue.rst b/docs/source/telegram.inputmediavenue.rst new file mode 100644 index 00000000000..898fa27bebd --- /dev/null +++ b/docs/source/telegram.inputmediavenue.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputMediaVenue +=============== + +.. currentmodule:: telegram + +.. autoclass:: InputMediaVenue + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmediavideo.rst b/docs/source/telegram.inputmediavideo.rst new file mode 100644 index 00000000000..2d6038999cc --- /dev/null +++ b/docs/source/telegram.inputmediavideo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputMediaVideo +=============== + +.. currentmodule:: telegram + +.. autoclass:: InputMediaVideo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputmessagecontent.rst b/docs/source/telegram.inputmessagecontent.rst new file mode 100644 index 00000000000..f4a1694abe3 --- /dev/null +++ b/docs/source/telegram.inputmessagecontent.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputMessageContent +=================== + +.. currentmodule:: telegram + +.. autoclass:: InputMessageContent + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpaidmedia.rst b/docs/source/telegram.inputpaidmedia.rst new file mode 100644 index 00000000000..216242efb71 --- /dev/null +++ b/docs/source/telegram.inputpaidmedia.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputPaidMedia +============== + +.. currentmodule:: telegram + +.. autoclass:: InputPaidMedia + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpaidmedialivephoto.rst b/docs/source/telegram.inputpaidmedialivephoto.rst new file mode 100644 index 00000000000..0e2c905514b --- /dev/null +++ b/docs/source/telegram.inputpaidmedialivephoto.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputPaidMediaLivePhoto +======================= + +.. currentmodule:: telegram + +.. autoclass:: InputPaidMediaLivePhoto + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpaidmediaphoto.rst b/docs/source/telegram.inputpaidmediaphoto.rst new file mode 100644 index 00000000000..a84522260f0 --- /dev/null +++ b/docs/source/telegram.inputpaidmediaphoto.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputPaidMediaPhoto +=================== + +.. currentmodule:: telegram + +.. autoclass:: InputPaidMediaPhoto + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpaidmediavideo.rst b/docs/source/telegram.inputpaidmediavideo.rst new file mode 100644 index 00000000000..bd718823c92 --- /dev/null +++ b/docs/source/telegram.inputpaidmediavideo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputPaidMediaVideo +=================== + +.. currentmodule:: telegram + +.. autoclass:: InputPaidMediaVideo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpollmedia.rst b/docs/source/telegram.inputpollmedia.rst index 9ad77737655..a7d4b8b8814 100644 --- a/docs/source/telegram.inputpollmedia.rst +++ b/docs/source/telegram.inputpollmedia.rst @@ -1,8 +1,3 @@ -.. This API page is maintained manually and is not generated by docs.auxil.api_docs. +.. Autogenerated page: True -InputPollMedia -============== - -.. versionadded:: NEXT.VERSION - -.. autoclass:: telegram.InputPollMedia +.. include:: telegram/inputpollmedia.rst diff --git a/docs/source/telegram.inputpolloption.rst b/docs/source/telegram.inputpolloption.rst new file mode 100644 index 00000000000..8ece4a7b1a3 --- /dev/null +++ b/docs/source/telegram.inputpolloption.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputPollOption +=============== + +.. currentmodule:: telegram + +.. autoclass:: InputPollOption + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputpolloptionmedia.rst b/docs/source/telegram.inputpolloptionmedia.rst index 0ee677a61a4..d1b204e5ff7 100644 --- a/docs/source/telegram.inputpolloptionmedia.rst +++ b/docs/source/telegram.inputpolloptionmedia.rst @@ -1,8 +1,3 @@ -.. This API page is maintained manually and is not generated by docs.auxil.api_docs. +.. Autogenerated page: True -InputPollOptionMedia -==================== - -.. versionadded:: NEXT.VERSION - -.. autoclass:: telegram.InputPollOptionMedia +.. include:: telegram/inputpolloptionmedia.rst diff --git a/docs/source/telegram.inputprofilephoto.rst b/docs/source/telegram.inputprofilephoto.rst new file mode 100644 index 00000000000..4749d92ee07 --- /dev/null +++ b/docs/source/telegram.inputprofilephoto.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputProfilePhoto +================= + +.. currentmodule:: telegram + +.. autoclass:: InputProfilePhoto + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputprofilephotoanimated.rst b/docs/source/telegram.inputprofilephotoanimated.rst new file mode 100644 index 00000000000..eef7d390069 --- /dev/null +++ b/docs/source/telegram.inputprofilephotoanimated.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputProfilePhotoAnimated +========================= + +.. currentmodule:: telegram + +.. autoclass:: InputProfilePhotoAnimated + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputprofilephotostatic.rst b/docs/source/telegram.inputprofilephotostatic.rst new file mode 100644 index 00000000000..e422fddf811 --- /dev/null +++ b/docs/source/telegram.inputprofilephotostatic.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputProfilePhotoStatic +======================= + +.. currentmodule:: telegram + +.. autoclass:: InputProfilePhotoStatic + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputsticker.rst b/docs/source/telegram.inputsticker.rst new file mode 100644 index 00000000000..6476b51e050 --- /dev/null +++ b/docs/source/telegram.inputsticker.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputSticker +============ + +.. currentmodule:: telegram + +.. autoclass:: InputSticker + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputstorycontent.rst b/docs/source/telegram.inputstorycontent.rst new file mode 100644 index 00000000000..526121fc2a6 --- /dev/null +++ b/docs/source/telegram.inputstorycontent.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputStoryContent +================= + +.. currentmodule:: telegram + +.. autoclass:: InputStoryContent + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputstorycontentphoto.rst b/docs/source/telegram.inputstorycontentphoto.rst new file mode 100644 index 00000000000..240fd17e548 --- /dev/null +++ b/docs/source/telegram.inputstorycontentphoto.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputStoryContentPhoto +====================== + +.. currentmodule:: telegram + +.. autoclass:: InputStoryContentPhoto + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputstorycontentvideo.rst b/docs/source/telegram.inputstorycontentvideo.rst new file mode 100644 index 00000000000..50f6a61255c --- /dev/null +++ b/docs/source/telegram.inputstorycontentvideo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputStoryContentVideo +====================== + +.. currentmodule:: telegram + +.. autoclass:: InputStoryContentVideo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputtextmessagecontent.rst b/docs/source/telegram.inputtextmessagecontent.rst new file mode 100644 index 00000000000..09e32231f9b --- /dev/null +++ b/docs/source/telegram.inputtextmessagecontent.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputTextMessageContent +======================= + +.. currentmodule:: telegram + +.. autoclass:: InputTextMessageContent + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.inputvenuemessagecontent.rst b/docs/source/telegram.inputvenuemessagecontent.rst new file mode 100644 index 00000000000..e3f704cc726 --- /dev/null +++ b/docs/source/telegram.inputvenuemessagecontent.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +InputVenueMessageContent +======================== + +.. currentmodule:: telegram + +.. autoclass:: InputVenueMessageContent + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.invoice.rst b/docs/source/telegram.invoice.rst new file mode 100644 index 00000000000..c9108d18615 --- /dev/null +++ b/docs/source/telegram.invoice.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Invoice +======= + +.. currentmodule:: telegram + +.. autoclass:: Invoice + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.keyboardbutton.rst b/docs/source/telegram.keyboardbutton.rst new file mode 100644 index 00000000000..312930a7454 --- /dev/null +++ b/docs/source/telegram.keyboardbutton.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +KeyboardButton +============== + +.. currentmodule:: telegram + +.. autoclass:: KeyboardButton + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.keyboardbuttonpolltype.rst b/docs/source/telegram.keyboardbuttonpolltype.rst new file mode 100644 index 00000000000..f1f6769fef2 --- /dev/null +++ b/docs/source/telegram.keyboardbuttonpolltype.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +KeyboardButtonPollType +====================== + +.. currentmodule:: telegram + +.. autoclass:: KeyboardButtonPollType + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.keyboardbuttonrequestchat.rst b/docs/source/telegram.keyboardbuttonrequestchat.rst new file mode 100644 index 00000000000..f23d0c3af04 --- /dev/null +++ b/docs/source/telegram.keyboardbuttonrequestchat.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +KeyboardButtonRequestChat +========================= + +.. currentmodule:: telegram + +.. autoclass:: KeyboardButtonRequestChat + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.keyboardbuttonrequestmanagedbot.rst b/docs/source/telegram.keyboardbuttonrequestmanagedbot.rst new file mode 100644 index 00000000000..03e6a9c467c --- /dev/null +++ b/docs/source/telegram.keyboardbuttonrequestmanagedbot.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +KeyboardButtonRequestManagedBot +=============================== + +.. currentmodule:: telegram + +.. autoclass:: KeyboardButtonRequestManagedBot + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.keyboardbuttonrequestusers.rst b/docs/source/telegram.keyboardbuttonrequestusers.rst new file mode 100644 index 00000000000..0a0b9ba23ae --- /dev/null +++ b/docs/source/telegram.keyboardbuttonrequestusers.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +KeyboardButtonRequestUsers +========================== + +.. currentmodule:: telegram + +.. autoclass:: KeyboardButtonRequestUsers + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.labeledprice.rst b/docs/source/telegram.labeledprice.rst new file mode 100644 index 00000000000..a0d4d7e5ff4 --- /dev/null +++ b/docs/source/telegram.labeledprice.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +LabeledPrice +============ + +.. currentmodule:: telegram + +.. autoclass:: LabeledPrice + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.linkpreviewoptions.rst b/docs/source/telegram.linkpreviewoptions.rst new file mode 100644 index 00000000000..5f0132efaa0 --- /dev/null +++ b/docs/source/telegram.linkpreviewoptions.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +LinkPreviewOptions +================== + +.. currentmodule:: telegram + +.. autoclass:: LinkPreviewOptions + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.livephoto.rst b/docs/source/telegram.livephoto.rst new file mode 100644 index 00000000000..97f6edaa4af --- /dev/null +++ b/docs/source/telegram.livephoto.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +LivePhoto +========= + +.. currentmodule:: telegram + +.. autoclass:: LivePhoto + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.location.rst b/docs/source/telegram.location.rst new file mode 100644 index 00000000000..bdd1ce18cb2 --- /dev/null +++ b/docs/source/telegram.location.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Location +======== + +.. currentmodule:: telegram + +.. autoclass:: Location + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.locationaddress.rst b/docs/source/telegram.locationaddress.rst new file mode 100644 index 00000000000..08a3f901778 --- /dev/null +++ b/docs/source/telegram.locationaddress.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +LocationAddress +=============== + +.. currentmodule:: telegram + +.. autoclass:: LocationAddress + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.loginurl.rst b/docs/source/telegram.loginurl.rst new file mode 100644 index 00000000000..4e1bb1f723a --- /dev/null +++ b/docs/source/telegram.loginurl.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +LoginUrl +======== + +.. currentmodule:: telegram + +.. autoclass:: LoginUrl + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.managedbotcreated.rst b/docs/source/telegram.managedbotcreated.rst new file mode 100644 index 00000000000..e3e10eb0019 --- /dev/null +++ b/docs/source/telegram.managedbotcreated.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ManagedBotCreated +================= + +.. currentmodule:: telegram + +.. autoclass:: ManagedBotCreated + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.managedbotupdated.rst b/docs/source/telegram.managedbotupdated.rst new file mode 100644 index 00000000000..0a897a1b0c8 --- /dev/null +++ b/docs/source/telegram.managedbotupdated.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ManagedBotUpdated +================= + +.. currentmodule:: telegram + +.. autoclass:: ManagedBotUpdated + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.maskposition.rst b/docs/source/telegram.maskposition.rst new file mode 100644 index 00000000000..f7eab72fd5d --- /dev/null +++ b/docs/source/telegram.maskposition.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MaskPosition +============ + +.. currentmodule:: telegram + +.. autoclass:: MaskPosition + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.maybeinaccessiblemessage.rst b/docs/source/telegram.maybeinaccessiblemessage.rst new file mode 100644 index 00000000000..446c7a7ce7c --- /dev/null +++ b/docs/source/telegram.maybeinaccessiblemessage.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MaybeInaccessibleMessage +======================== + +.. currentmodule:: telegram + +.. autoclass:: MaybeInaccessibleMessage + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.menubutton.rst b/docs/source/telegram.menubutton.rst new file mode 100644 index 00000000000..1bf079639ba --- /dev/null +++ b/docs/source/telegram.menubutton.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MenuButton +========== + +.. currentmodule:: telegram + +.. autoclass:: MenuButton + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.menubuttoncommands.rst b/docs/source/telegram.menubuttoncommands.rst new file mode 100644 index 00000000000..df7fb8b56c4 --- /dev/null +++ b/docs/source/telegram.menubuttoncommands.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MenuButtonCommands +================== + +.. currentmodule:: telegram + +.. autoclass:: MenuButtonCommands + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.menubuttondefault.rst b/docs/source/telegram.menubuttondefault.rst new file mode 100644 index 00000000000..c69471b8cc2 --- /dev/null +++ b/docs/source/telegram.menubuttondefault.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MenuButtonDefault +================= + +.. currentmodule:: telegram + +.. autoclass:: MenuButtonDefault + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.menubuttonwebapp.rst b/docs/source/telegram.menubuttonwebapp.rst new file mode 100644 index 00000000000..96a8443aded --- /dev/null +++ b/docs/source/telegram.menubuttonwebapp.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MenuButtonWebApp +================ + +.. currentmodule:: telegram + +.. autoclass:: MenuButtonWebApp + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.message.rst b/docs/source/telegram.message.rst new file mode 100644 index 00000000000..0bac928bb29 --- /dev/null +++ b/docs/source/telegram.message.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Message +======= + +.. currentmodule:: telegram + +.. autoclass:: Message + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageautodeletetimerchanged.rst b/docs/source/telegram.messageautodeletetimerchanged.rst new file mode 100644 index 00000000000..d9480cd6472 --- /dev/null +++ b/docs/source/telegram.messageautodeletetimerchanged.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MessageAutoDeleteTimerChanged +============================= + +.. currentmodule:: telegram + +.. autoclass:: MessageAutoDeleteTimerChanged + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageentity.rst b/docs/source/telegram.messageentity.rst new file mode 100644 index 00000000000..6408be71e5d --- /dev/null +++ b/docs/source/telegram.messageentity.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MessageEntity +============= + +.. currentmodule:: telegram + +.. autoclass:: MessageEntity + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageid.rst b/docs/source/telegram.messageid.rst new file mode 100644 index 00000000000..590b475ba66 --- /dev/null +++ b/docs/source/telegram.messageid.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MessageId +========= + +.. currentmodule:: telegram + +.. autoclass:: MessageId + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageorigin.rst b/docs/source/telegram.messageorigin.rst new file mode 100644 index 00000000000..e81fd14d00e --- /dev/null +++ b/docs/source/telegram.messageorigin.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MessageOrigin +============= + +.. currentmodule:: telegram + +.. autoclass:: MessageOrigin + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageoriginchannel.rst b/docs/source/telegram.messageoriginchannel.rst new file mode 100644 index 00000000000..f0763b3fbfd --- /dev/null +++ b/docs/source/telegram.messageoriginchannel.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MessageOriginChannel +==================== + +.. currentmodule:: telegram + +.. autoclass:: MessageOriginChannel + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageoriginchat.rst b/docs/source/telegram.messageoriginchat.rst new file mode 100644 index 00000000000..19ae6c0e96b --- /dev/null +++ b/docs/source/telegram.messageoriginchat.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MessageOriginChat +================= + +.. currentmodule:: telegram + +.. autoclass:: MessageOriginChat + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageoriginhiddenuser.rst b/docs/source/telegram.messageoriginhiddenuser.rst new file mode 100644 index 00000000000..53310942b30 --- /dev/null +++ b/docs/source/telegram.messageoriginhiddenuser.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MessageOriginHiddenUser +======================= + +.. currentmodule:: telegram + +.. autoclass:: MessageOriginHiddenUser + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messageoriginuser.rst b/docs/source/telegram.messageoriginuser.rst new file mode 100644 index 00000000000..b71069cb03a --- /dev/null +++ b/docs/source/telegram.messageoriginuser.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MessageOriginUser +================= + +.. currentmodule:: telegram + +.. autoclass:: MessageOriginUser + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messagereactioncountupdated.rst b/docs/source/telegram.messagereactioncountupdated.rst new file mode 100644 index 00000000000..5acd94836e3 --- /dev/null +++ b/docs/source/telegram.messagereactioncountupdated.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MessageReactionCountUpdated +=========================== + +.. currentmodule:: telegram + +.. autoclass:: MessageReactionCountUpdated + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.messagereactionupdated.rst b/docs/source/telegram.messagereactionupdated.rst new file mode 100644 index 00000000000..0c0a684bab1 --- /dev/null +++ b/docs/source/telegram.messagereactionupdated.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +MessageReactionUpdated +====================== + +.. currentmodule:: telegram + +.. autoclass:: MessageReactionUpdated + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.orderinfo.rst b/docs/source/telegram.orderinfo.rst new file mode 100644 index 00000000000..dab2aa21b47 --- /dev/null +++ b/docs/source/telegram.orderinfo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +OrderInfo +========= + +.. currentmodule:: telegram + +.. autoclass:: OrderInfo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ownedgift.rst b/docs/source/telegram.ownedgift.rst new file mode 100644 index 00000000000..74e671698c0 --- /dev/null +++ b/docs/source/telegram.ownedgift.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +OwnedGift +========= + +.. currentmodule:: telegram + +.. autoclass:: OwnedGift + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ownedgiftregular.rst b/docs/source/telegram.ownedgiftregular.rst new file mode 100644 index 00000000000..fc70761eba4 --- /dev/null +++ b/docs/source/telegram.ownedgiftregular.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +OwnedGiftRegular +================ + +.. currentmodule:: telegram + +.. autoclass:: OwnedGiftRegular + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ownedgifts.rst b/docs/source/telegram.ownedgifts.rst new file mode 100644 index 00000000000..0b3b343880a --- /dev/null +++ b/docs/source/telegram.ownedgifts.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +OwnedGifts +========== + +.. currentmodule:: telegram + +.. autoclass:: OwnedGifts + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ownedgiftunique.rst b/docs/source/telegram.ownedgiftunique.rst new file mode 100644 index 00000000000..5ae51f60db6 --- /dev/null +++ b/docs/source/telegram.ownedgiftunique.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +OwnedGiftUnique +=============== + +.. currentmodule:: telegram + +.. autoclass:: OwnedGiftUnique + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmedia.rst b/docs/source/telegram.paidmedia.rst new file mode 100644 index 00000000000..437139b7ab3 --- /dev/null +++ b/docs/source/telegram.paidmedia.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PaidMedia +========= + +.. currentmodule:: telegram + +.. autoclass:: PaidMedia + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmediainfo.rst b/docs/source/telegram.paidmediainfo.rst new file mode 100644 index 00000000000..5e7814f4436 --- /dev/null +++ b/docs/source/telegram.paidmediainfo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PaidMediaInfo +============= + +.. currentmodule:: telegram + +.. autoclass:: PaidMediaInfo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmedialivephoto.rst b/docs/source/telegram.paidmedialivephoto.rst new file mode 100644 index 00000000000..b646cc66be9 --- /dev/null +++ b/docs/source/telegram.paidmedialivephoto.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PaidMediaLivePhoto +================== + +.. currentmodule:: telegram + +.. autoclass:: PaidMediaLivePhoto + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmediaphoto.rst b/docs/source/telegram.paidmediaphoto.rst new file mode 100644 index 00000000000..6b4ed55030a --- /dev/null +++ b/docs/source/telegram.paidmediaphoto.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PaidMediaPhoto +============== + +.. currentmodule:: telegram + +.. autoclass:: PaidMediaPhoto + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmediapreview.rst b/docs/source/telegram.paidmediapreview.rst new file mode 100644 index 00000000000..e25654b60ab --- /dev/null +++ b/docs/source/telegram.paidmediapreview.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PaidMediaPreview +================ + +.. currentmodule:: telegram + +.. autoclass:: PaidMediaPreview + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmediapurchased.rst b/docs/source/telegram.paidmediapurchased.rst new file mode 100644 index 00000000000..12afaa94471 --- /dev/null +++ b/docs/source/telegram.paidmediapurchased.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PaidMediaPurchased +================== + +.. currentmodule:: telegram + +.. autoclass:: PaidMediaPurchased + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmediavideo.rst b/docs/source/telegram.paidmediavideo.rst new file mode 100644 index 00000000000..a16bede8f37 --- /dev/null +++ b/docs/source/telegram.paidmediavideo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PaidMediaVideo +============== + +.. currentmodule:: telegram + +.. autoclass:: PaidMediaVideo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.paidmessagepricechanged.rst b/docs/source/telegram.paidmessagepricechanged.rst new file mode 100644 index 00000000000..fc6beeab094 --- /dev/null +++ b/docs/source/telegram.paidmessagepricechanged.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PaidMessagePriceChanged +======================= + +.. currentmodule:: telegram + +.. autoclass:: PaidMessagePriceChanged + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passport-tree.rst b/docs/source/telegram.passport-tree.rst index 079ce948924..02cf34503c7 100644 --- a/docs/source/telegram.passport-tree.rst +++ b/docs/source/telegram.passport-tree.rst @@ -1,31 +1,6 @@ -Passport --------- - -Passport is a unified authorization method for services that require personal identification. Users can upload their documents once, then instantly share their data with services that require real-world ID (finance, ICOs, etc.). Please see the `manual `_ for details. +.. Autogenerated page: True +.. _passport-tree: -.. toctree:: - :titlesonly: - - telegram.credentials - telegram.datacredentials - telegram.encryptedcredentials - telegram.encryptedpassportelement - telegram.filecredentials - telegram.iddocumentdata - telegram.passportdata - telegram.passportelementerror - telegram.passportelementerrordatafield - telegram.passportelementerrorfile - telegram.passportelementerrorfiles - telegram.passportelementerrorfrontside - telegram.passportelementerrorreverseside - telegram.passportelementerrorselfie - telegram.passportelementerrortranslationfile - telegram.passportelementerrortranslationfiles - telegram.passportelementerrorunspecified - telegram.passportfile - telegram.personaldetails - telegram.residentialaddress - telegram.securedata - telegram.securevalue +Passport +-------- diff --git a/docs/source/telegram.passportdata.rst b/docs/source/telegram.passportdata.rst new file mode 100644 index 00000000000..5f683d7b52b --- /dev/null +++ b/docs/source/telegram.passportdata.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PassportData +============ + +.. currentmodule:: telegram + +.. autoclass:: PassportData + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerror.rst b/docs/source/telegram.passportelementerror.rst new file mode 100644 index 00000000000..10660e35f13 --- /dev/null +++ b/docs/source/telegram.passportelementerror.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PassportElementError +==================== + +.. currentmodule:: telegram + +.. autoclass:: PassportElementError + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrordatafield.rst b/docs/source/telegram.passportelementerrordatafield.rst new file mode 100644 index 00000000000..1e4652105f6 --- /dev/null +++ b/docs/source/telegram.passportelementerrordatafield.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PassportElementErrorDataField +============================= + +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorDataField + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrorfile.rst b/docs/source/telegram.passportelementerrorfile.rst new file mode 100644 index 00000000000..a981279eee4 --- /dev/null +++ b/docs/source/telegram.passportelementerrorfile.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PassportElementErrorFile +======================== + +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorFile + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrorfiles.rst b/docs/source/telegram.passportelementerrorfiles.rst new file mode 100644 index 00000000000..8f713c5e434 --- /dev/null +++ b/docs/source/telegram.passportelementerrorfiles.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PassportElementErrorFiles +========================= + +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorFiles + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrorfrontside.rst b/docs/source/telegram.passportelementerrorfrontside.rst new file mode 100644 index 00000000000..2cd00936e95 --- /dev/null +++ b/docs/source/telegram.passportelementerrorfrontside.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PassportElementErrorFrontSide +============================= + +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorFrontSide + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrorreverseside.rst b/docs/source/telegram.passportelementerrorreverseside.rst new file mode 100644 index 00000000000..3165a4f6f82 --- /dev/null +++ b/docs/source/telegram.passportelementerrorreverseside.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PassportElementErrorReverseSide +=============================== + +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorReverseSide + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrorselfie.rst b/docs/source/telegram.passportelementerrorselfie.rst new file mode 100644 index 00000000000..d48aac3dcef --- /dev/null +++ b/docs/source/telegram.passportelementerrorselfie.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PassportElementErrorSelfie +========================== + +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorSelfie + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrortranslationfile.rst b/docs/source/telegram.passportelementerrortranslationfile.rst new file mode 100644 index 00000000000..3a225cb4acc --- /dev/null +++ b/docs/source/telegram.passportelementerrortranslationfile.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PassportElementErrorTranslationFile +=================================== + +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorTranslationFile + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrortranslationfiles.rst b/docs/source/telegram.passportelementerrortranslationfiles.rst new file mode 100644 index 00000000000..db8f6c91a3e --- /dev/null +++ b/docs/source/telegram.passportelementerrortranslationfiles.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PassportElementErrorTranslationFiles +==================================== + +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorTranslationFiles + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportelementerrorunspecified.rst b/docs/source/telegram.passportelementerrorunspecified.rst new file mode 100644 index 00000000000..b0ef6977543 --- /dev/null +++ b/docs/source/telegram.passportelementerrorunspecified.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PassportElementErrorUnspecified +=============================== + +.. currentmodule:: telegram + +.. autoclass:: PassportElementErrorUnspecified + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.passportfile.rst b/docs/source/telegram.passportfile.rst new file mode 100644 index 00000000000..f285ddf1ec0 --- /dev/null +++ b/docs/source/telegram.passportfile.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PassportFile +============ + +.. currentmodule:: telegram + +.. autoclass:: PassportFile + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.payments-tree.rst b/docs/source/telegram.payments-tree.rst index 94e4fec3c99..5d07f94f47b 100644 --- a/docs/source/telegram.payments-tree.rst +++ b/docs/source/telegram.payments-tree.rst @@ -1,36 +1,6 @@ +.. Autogenerated page: True + .. _payments-tree: Payments -------- - -Your bot can accept payments from Telegram users. Please see the `introduction to payments `_ for more details on the process and how to set up payments for your bot. - - -.. toctree:: - :titlesonly: - - telegram.affiliateinfo - telegram.invoice - telegram.labeledprice - telegram.orderinfo - telegram.precheckoutquery - telegram.refundedpayment - telegram.revenuewithdrawalstate - telegram.revenuewithdrawalstatefailed - telegram.revenuewithdrawalstatepending - telegram.revenuewithdrawalstatesucceeded - telegram.shippingaddress - telegram.shippingoption - telegram.shippingquery - telegram.staramount - telegram.startransaction - telegram.startransactions - telegram.successfulpayment - telegram.transactionpartner - telegram.transactionpartneraffiliateprogram - telegram.transactionpartnerchat - telegram.transactionpartnerfragment - telegram.transactionpartnerother - telegram.transactionpartnertelegramads - telegram.transactionpartnertelegramapi - telegram.transactionpartneruser diff --git a/docs/source/telegram.personaldetails.rst b/docs/source/telegram.personaldetails.rst new file mode 100644 index 00000000000..37a434ab410 --- /dev/null +++ b/docs/source/telegram.personaldetails.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PersonalDetails +=============== + +.. currentmodule:: telegram + +.. autoclass:: PersonalDetails + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.photosize.rst b/docs/source/telegram.photosize.rst new file mode 100644 index 00000000000..327e23603b1 --- /dev/null +++ b/docs/source/telegram.photosize.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PhotoSize +========= + +.. currentmodule:: telegram + +.. autoclass:: PhotoSize + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.poll.rst b/docs/source/telegram.poll.rst new file mode 100644 index 00000000000..b287aad38d7 --- /dev/null +++ b/docs/source/telegram.poll.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Poll +==== + +.. currentmodule:: telegram + +.. autoclass:: Poll + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.pollanswer.rst b/docs/source/telegram.pollanswer.rst new file mode 100644 index 00000000000..2ddb525299f --- /dev/null +++ b/docs/source/telegram.pollanswer.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PollAnswer +========== + +.. currentmodule:: telegram + +.. autoclass:: PollAnswer + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.pollmedia.rst b/docs/source/telegram.pollmedia.rst new file mode 100644 index 00000000000..86e6ac9722f --- /dev/null +++ b/docs/source/telegram.pollmedia.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PollMedia +========= + +.. currentmodule:: telegram + +.. autoclass:: PollMedia + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.polloption.rst b/docs/source/telegram.polloption.rst new file mode 100644 index 00000000000..1de17bf1fa2 --- /dev/null +++ b/docs/source/telegram.polloption.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PollOption +========== + +.. currentmodule:: telegram + +.. autoclass:: PollOption + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.polloptionadded.rst b/docs/source/telegram.polloptionadded.rst new file mode 100644 index 00000000000..03619e59701 --- /dev/null +++ b/docs/source/telegram.polloptionadded.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PollOptionAdded +=============== + +.. currentmodule:: telegram + +.. autoclass:: PollOptionAdded + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.polloptiondeleted.rst b/docs/source/telegram.polloptiondeleted.rst new file mode 100644 index 00000000000..0f56efaf2b6 --- /dev/null +++ b/docs/source/telegram.polloptiondeleted.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PollOptionDeleted +================= + +.. currentmodule:: telegram + +.. autoclass:: PollOptionDeleted + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.precheckoutquery.rst b/docs/source/telegram.precheckoutquery.rst new file mode 100644 index 00000000000..53c2a1ebc5e --- /dev/null +++ b/docs/source/telegram.precheckoutquery.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PreCheckoutQuery +================ + +.. currentmodule:: telegram + +.. autoclass:: PreCheckoutQuery + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.preparedinlinemessage.rst b/docs/source/telegram.preparedinlinemessage.rst new file mode 100644 index 00000000000..bf53a046592 --- /dev/null +++ b/docs/source/telegram.preparedinlinemessage.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PreparedInlineMessage +===================== + +.. currentmodule:: telegram + +.. autoclass:: PreparedInlineMessage + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.preparedkeyboardbutton.rst b/docs/source/telegram.preparedkeyboardbutton.rst new file mode 100644 index 00000000000..8c97748f2c6 --- /dev/null +++ b/docs/source/telegram.preparedkeyboardbutton.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +PreparedKeyboardButton +====================== + +.. currentmodule:: telegram + +.. autoclass:: PreparedKeyboardButton + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.proximityalerttriggered.rst b/docs/source/telegram.proximityalerttriggered.rst new file mode 100644 index 00000000000..9c1145165cc --- /dev/null +++ b/docs/source/telegram.proximityalerttriggered.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ProximityAlertTriggered +======================= + +.. currentmodule:: telegram + +.. autoclass:: ProximityAlertTriggered + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.reactioncount.rst b/docs/source/telegram.reactioncount.rst new file mode 100644 index 00000000000..cfa98663161 --- /dev/null +++ b/docs/source/telegram.reactioncount.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ReactionCount +============= + +.. currentmodule:: telegram + +.. autoclass:: ReactionCount + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.reactiontype.rst b/docs/source/telegram.reactiontype.rst new file mode 100644 index 00000000000..39162565321 --- /dev/null +++ b/docs/source/telegram.reactiontype.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ReactionType +============ + +.. currentmodule:: telegram + +.. autoclass:: ReactionType + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.reactiontypecustomemoji.rst b/docs/source/telegram.reactiontypecustomemoji.rst new file mode 100644 index 00000000000..98984d65174 --- /dev/null +++ b/docs/source/telegram.reactiontypecustomemoji.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ReactionTypeCustomEmoji +======================= + +.. currentmodule:: telegram + +.. autoclass:: ReactionTypeCustomEmoji + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.reactiontypeemoji.rst b/docs/source/telegram.reactiontypeemoji.rst new file mode 100644 index 00000000000..c3810a86477 --- /dev/null +++ b/docs/source/telegram.reactiontypeemoji.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ReactionTypeEmoji +================= + +.. currentmodule:: telegram + +.. autoclass:: ReactionTypeEmoji + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.reactiontypepaid.rst b/docs/source/telegram.reactiontypepaid.rst new file mode 100644 index 00000000000..37d514e48eb --- /dev/null +++ b/docs/source/telegram.reactiontypepaid.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ReactionTypePaid +================ + +.. currentmodule:: telegram + +.. autoclass:: ReactionTypePaid + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.refundedpayment.rst b/docs/source/telegram.refundedpayment.rst new file mode 100644 index 00000000000..21d6c95cb70 --- /dev/null +++ b/docs/source/telegram.refundedpayment.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +RefundedPayment +=============== + +.. currentmodule:: telegram + +.. autoclass:: RefundedPayment + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.replykeyboardmarkup.rst b/docs/source/telegram.replykeyboardmarkup.rst new file mode 100644 index 00000000000..3e90f0f9552 --- /dev/null +++ b/docs/source/telegram.replykeyboardmarkup.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ReplyKeyboardMarkup +=================== + +.. currentmodule:: telegram + +.. autoclass:: ReplyKeyboardMarkup + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.replykeyboardremove.rst b/docs/source/telegram.replykeyboardremove.rst new file mode 100644 index 00000000000..fa87a656ef0 --- /dev/null +++ b/docs/source/telegram.replykeyboardremove.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ReplyKeyboardRemove +=================== + +.. currentmodule:: telegram + +.. autoclass:: ReplyKeyboardRemove + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.replyparameters.rst b/docs/source/telegram.replyparameters.rst new file mode 100644 index 00000000000..86e3757e15a --- /dev/null +++ b/docs/source/telegram.replyparameters.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ReplyParameters +=============== + +.. currentmodule:: telegram + +.. autoclass:: ReplyParameters + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.request.baserequest.rst b/docs/source/telegram.request.baserequest.rst new file mode 100644 index 00000000000..8edba8440c9 --- /dev/null +++ b/docs/source/telegram.request.baserequest.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +BaseRequest +=========== + +.. currentmodule:: telegram.request + +.. autoclass:: BaseRequest + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.request.httpxrequest.rst b/docs/source/telegram.request.httpxrequest.rst new file mode 100644 index 00000000000..263b9b23044 --- /dev/null +++ b/docs/source/telegram.request.httpxrequest.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +HTTPXRequest +============ + +.. currentmodule:: telegram.request + +.. autoclass:: HTTPXRequest + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.request.requestdata.rst b/docs/source/telegram.request.requestdata.rst new file mode 100644 index 00000000000..f5723555e89 --- /dev/null +++ b/docs/source/telegram.request.requestdata.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +RequestData +=========== + +.. currentmodule:: telegram.request + +.. autoclass:: RequestData + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.request.rst b/docs/source/telegram.request.rst index 198c01bbd4c..ce77fb2d8c4 100644 --- a/docs/source/telegram.request.rst +++ b/docs/source/telegram.request.rst @@ -1,6 +1,3 @@ -telegram.request Module -======================= +.. Autogenerated page: True -.. versionadded:: 20.0 - -.. ptb-api-toctree:: request +.. include:: telegram/request/index.rst diff --git a/docs/source/telegram.residentialaddress.rst b/docs/source/telegram.residentialaddress.rst new file mode 100644 index 00000000000..ae57f4ea6f8 --- /dev/null +++ b/docs/source/telegram.residentialaddress.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ResidentialAddress +================== + +.. currentmodule:: telegram + +.. autoclass:: ResidentialAddress + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.revenuewithdrawalstate.rst b/docs/source/telegram.revenuewithdrawalstate.rst new file mode 100644 index 00000000000..fc250e9aa60 --- /dev/null +++ b/docs/source/telegram.revenuewithdrawalstate.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +RevenueWithdrawalState +====================== + +.. currentmodule:: telegram + +.. autoclass:: RevenueWithdrawalState + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.revenuewithdrawalstatefailed.rst b/docs/source/telegram.revenuewithdrawalstatefailed.rst new file mode 100644 index 00000000000..ec396a19704 --- /dev/null +++ b/docs/source/telegram.revenuewithdrawalstatefailed.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +RevenueWithdrawalStateFailed +============================ + +.. currentmodule:: telegram + +.. autoclass:: RevenueWithdrawalStateFailed + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.revenuewithdrawalstatepending.rst b/docs/source/telegram.revenuewithdrawalstatepending.rst new file mode 100644 index 00000000000..c579b4fddb0 --- /dev/null +++ b/docs/source/telegram.revenuewithdrawalstatepending.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +RevenueWithdrawalStatePending +============================= + +.. currentmodule:: telegram + +.. autoclass:: RevenueWithdrawalStatePending + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.revenuewithdrawalstatesucceeded.rst b/docs/source/telegram.revenuewithdrawalstatesucceeded.rst new file mode 100644 index 00000000000..3ca58524fb6 --- /dev/null +++ b/docs/source/telegram.revenuewithdrawalstatesucceeded.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +RevenueWithdrawalStateSucceeded +=============================== + +.. currentmodule:: telegram + +.. autoclass:: RevenueWithdrawalStateSucceeded + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.rst b/docs/source/telegram.rst index fe3eac4a06f..d74f9e2b234 100644 --- a/docs/source/telegram.rst +++ b/docs/source/telegram.rst @@ -1,23 +1,3 @@ -telegram package -================ - -Version Constants ------------------ - -.. automodule:: telegram - :members: __version__, __version_info__, __bot_api_version__, __bot_api_version_info__ - -Classes in this package ------------------------ - -.. toctree:: - :titlesonly: - - telegram.bot - telegram.at-tree.rst - telegram.stickers-tree.rst - telegram.inline-tree.rst - telegram.payments-tree.rst - telegram.games-tree.rst - telegram.passport-tree.rst +.. Autogenerated page: True +.. include:: telegram/index.rst diff --git a/docs/source/telegram.securedata.rst b/docs/source/telegram.securedata.rst new file mode 100644 index 00000000000..f9eebec3d90 --- /dev/null +++ b/docs/source/telegram.securedata.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SecureData +========== + +.. currentmodule:: telegram + +.. autoclass:: SecureData + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.securevalue.rst b/docs/source/telegram.securevalue.rst new file mode 100644 index 00000000000..b6d46f83f9b --- /dev/null +++ b/docs/source/telegram.securevalue.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SecureValue +=========== + +.. currentmodule:: telegram + +.. autoclass:: SecureValue + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.sentguestmessage.rst b/docs/source/telegram.sentguestmessage.rst new file mode 100644 index 00000000000..9117c9eb3d1 --- /dev/null +++ b/docs/source/telegram.sentguestmessage.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SentGuestMessage +================ + +.. currentmodule:: telegram + +.. autoclass:: SentGuestMessage + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.sentwebappmessage.rst b/docs/source/telegram.sentwebappmessage.rst new file mode 100644 index 00000000000..509627b63d1 --- /dev/null +++ b/docs/source/telegram.sentwebappmessage.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SentWebAppMessage +================= + +.. currentmodule:: telegram + +.. autoclass:: SentWebAppMessage + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.shareduser.rst b/docs/source/telegram.shareduser.rst new file mode 100644 index 00000000000..77b059498a6 --- /dev/null +++ b/docs/source/telegram.shareduser.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SharedUser +========== + +.. currentmodule:: telegram + +.. autoclass:: SharedUser + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.shippingaddress.rst b/docs/source/telegram.shippingaddress.rst new file mode 100644 index 00000000000..251117fe288 --- /dev/null +++ b/docs/source/telegram.shippingaddress.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ShippingAddress +=============== + +.. currentmodule:: telegram + +.. autoclass:: ShippingAddress + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.shippingoption.rst b/docs/source/telegram.shippingoption.rst new file mode 100644 index 00000000000..25e4e9e03ce --- /dev/null +++ b/docs/source/telegram.shippingoption.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ShippingOption +============== + +.. currentmodule:: telegram + +.. autoclass:: ShippingOption + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.shippingquery.rst b/docs/source/telegram.shippingquery.rst new file mode 100644 index 00000000000..6045ccccf30 --- /dev/null +++ b/docs/source/telegram.shippingquery.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +ShippingQuery +============= + +.. currentmodule:: telegram + +.. autoclass:: ShippingQuery + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.staramount.rst b/docs/source/telegram.staramount.rst new file mode 100644 index 00000000000..fce1d1fa4e7 --- /dev/null +++ b/docs/source/telegram.staramount.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +StarAmount +========== + +.. currentmodule:: telegram + +.. autoclass:: StarAmount + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.startransaction.rst b/docs/source/telegram.startransaction.rst new file mode 100644 index 00000000000..09a585a29b0 --- /dev/null +++ b/docs/source/telegram.startransaction.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +StarTransaction +=============== + +.. currentmodule:: telegram + +.. autoclass:: StarTransaction + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.startransactions.rst b/docs/source/telegram.startransactions.rst new file mode 100644 index 00000000000..5881560e43a --- /dev/null +++ b/docs/source/telegram.startransactions.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +StarTransactions +================ + +.. currentmodule:: telegram + +.. autoclass:: StarTransactions + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.sticker.rst b/docs/source/telegram.sticker.rst new file mode 100644 index 00000000000..08c847e412a --- /dev/null +++ b/docs/source/telegram.sticker.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Sticker +======= + +.. currentmodule:: telegram + +.. autoclass:: Sticker + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.stickers-tree.rst b/docs/source/telegram.stickers-tree.rst index e45dcacb56b..d4445779d79 100644 --- a/docs/source/telegram.stickers-tree.rst +++ b/docs/source/telegram.stickers-tree.rst @@ -1,14 +1,6 @@ -Stickers --------- - -The following methods and objects allow your bot to handle stickers and sticker sets. +.. Autogenerated page: True -.. toctree:: - :titlesonly: +.. _stickers-tree: - telegram.gift - telegram.gifts - telegram.inputsticker - telegram.maskposition - telegram.sticker - telegram.stickerset +Stickers +-------- diff --git a/docs/source/telegram.stickerset.rst b/docs/source/telegram.stickerset.rst new file mode 100644 index 00000000000..8911ff3b7ca --- /dev/null +++ b/docs/source/telegram.stickerset.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +StickerSet +========== + +.. currentmodule:: telegram + +.. autoclass:: StickerSet + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.story.rst b/docs/source/telegram.story.rst new file mode 100644 index 00000000000..d7d289e3aab --- /dev/null +++ b/docs/source/telegram.story.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Story +===== + +.. currentmodule:: telegram + +.. autoclass:: Story + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyarea.rst b/docs/source/telegram.storyarea.rst new file mode 100644 index 00000000000..3dba7d8984e --- /dev/null +++ b/docs/source/telegram.storyarea.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +StoryArea +========= + +.. currentmodule:: telegram + +.. autoclass:: StoryArea + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyareaposition.rst b/docs/source/telegram.storyareaposition.rst new file mode 100644 index 00000000000..b0fd4bf1102 --- /dev/null +++ b/docs/source/telegram.storyareaposition.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +StoryAreaPosition +================= + +.. currentmodule:: telegram + +.. autoclass:: StoryAreaPosition + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyareatype.rst b/docs/source/telegram.storyareatype.rst new file mode 100644 index 00000000000..8e3784ae202 --- /dev/null +++ b/docs/source/telegram.storyareatype.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +StoryAreaType +============= + +.. currentmodule:: telegram + +.. autoclass:: StoryAreaType + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyareatypelink.rst b/docs/source/telegram.storyareatypelink.rst new file mode 100644 index 00000000000..834430c5b7a --- /dev/null +++ b/docs/source/telegram.storyareatypelink.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +StoryAreaTypeLink +================= + +.. currentmodule:: telegram + +.. autoclass:: StoryAreaTypeLink + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyareatypelocation.rst b/docs/source/telegram.storyareatypelocation.rst new file mode 100644 index 00000000000..96c5d94932e --- /dev/null +++ b/docs/source/telegram.storyareatypelocation.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +StoryAreaTypeLocation +===================== + +.. currentmodule:: telegram + +.. autoclass:: StoryAreaTypeLocation + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyareatypesuggestedreaction.rst b/docs/source/telegram.storyareatypesuggestedreaction.rst new file mode 100644 index 00000000000..dff17554c3a --- /dev/null +++ b/docs/source/telegram.storyareatypesuggestedreaction.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +StoryAreaTypeSuggestedReaction +============================== + +.. currentmodule:: telegram + +.. autoclass:: StoryAreaTypeSuggestedReaction + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyareatypeuniquegift.rst b/docs/source/telegram.storyareatypeuniquegift.rst new file mode 100644 index 00000000000..a1900d1b1c3 --- /dev/null +++ b/docs/source/telegram.storyareatypeuniquegift.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +StoryAreaTypeUniqueGift +======================= + +.. currentmodule:: telegram + +.. autoclass:: StoryAreaTypeUniqueGift + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.storyareatypeweather.rst b/docs/source/telegram.storyareatypeweather.rst new file mode 100644 index 00000000000..a102fac5a0b --- /dev/null +++ b/docs/source/telegram.storyareatypeweather.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +StoryAreaTypeWeather +==================== + +.. currentmodule:: telegram + +.. autoclass:: StoryAreaTypeWeather + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.successfulpayment.rst b/docs/source/telegram.successfulpayment.rst new file mode 100644 index 00000000000..7e61fb1032b --- /dev/null +++ b/docs/source/telegram.successfulpayment.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SuccessfulPayment +================= + +.. currentmodule:: telegram + +.. autoclass:: SuccessfulPayment + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostapprovalfailed.rst b/docs/source/telegram.suggestedpostapprovalfailed.rst new file mode 100644 index 00000000000..2a9970953a2 --- /dev/null +++ b/docs/source/telegram.suggestedpostapprovalfailed.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SuggestedPostApprovalFailed +=========================== + +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostApprovalFailed + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostapproved.rst b/docs/source/telegram.suggestedpostapproved.rst new file mode 100644 index 00000000000..48d8886dd1c --- /dev/null +++ b/docs/source/telegram.suggestedpostapproved.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SuggestedPostApproved +===================== + +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostApproved + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostdeclined.rst b/docs/source/telegram.suggestedpostdeclined.rst new file mode 100644 index 00000000000..69fadfa4003 --- /dev/null +++ b/docs/source/telegram.suggestedpostdeclined.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SuggestedPostDeclined +===================== + +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostDeclined + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostinfo.rst b/docs/source/telegram.suggestedpostinfo.rst new file mode 100644 index 00000000000..170f031b424 --- /dev/null +++ b/docs/source/telegram.suggestedpostinfo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SuggestedPostInfo +================= + +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostInfo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostpaid.rst b/docs/source/telegram.suggestedpostpaid.rst new file mode 100644 index 00000000000..baf7a97df9b --- /dev/null +++ b/docs/source/telegram.suggestedpostpaid.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SuggestedPostPaid +================= + +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostPaid + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostparameters.rst b/docs/source/telegram.suggestedpostparameters.rst new file mode 100644 index 00000000000..4804ea77d93 --- /dev/null +++ b/docs/source/telegram.suggestedpostparameters.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SuggestedPostParameters +======================= + +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostParameters + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostprice.rst b/docs/source/telegram.suggestedpostprice.rst new file mode 100644 index 00000000000..51f6fdb5b7e --- /dev/null +++ b/docs/source/telegram.suggestedpostprice.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SuggestedPostPrice +================== + +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostPrice + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.suggestedpostrefunded.rst b/docs/source/telegram.suggestedpostrefunded.rst new file mode 100644 index 00000000000..bfc7efef316 --- /dev/null +++ b/docs/source/telegram.suggestedpostrefunded.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SuggestedPostRefunded +===================== + +.. currentmodule:: telegram + +.. autoclass:: SuggestedPostRefunded + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.switchinlinequerychosenchat.rst b/docs/source/telegram.switchinlinequerychosenchat.rst new file mode 100644 index 00000000000..e08f4fa606a --- /dev/null +++ b/docs/source/telegram.switchinlinequerychosenchat.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +SwitchInlineQueryChosenChat +=========================== + +.. currentmodule:: telegram + +.. autoclass:: SwitchInlineQueryChosenChat + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.telegramobject.rst b/docs/source/telegram.telegramobject.rst new file mode 100644 index 00000000000..661f1eccccc --- /dev/null +++ b/docs/source/telegram.telegramobject.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +TelegramObject +============== + +.. currentmodule:: telegram + +.. autoclass:: TelegramObject + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.textquote.rst b/docs/source/telegram.textquote.rst new file mode 100644 index 00000000000..87a45c121fa --- /dev/null +++ b/docs/source/telegram.textquote.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +TextQuote +========= + +.. currentmodule:: telegram + +.. autoclass:: TextQuote + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartner.rst b/docs/source/telegram.transactionpartner.rst new file mode 100644 index 00000000000..3b8afc17519 --- /dev/null +++ b/docs/source/telegram.transactionpartner.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +TransactionPartner +================== + +.. currentmodule:: telegram + +.. autoclass:: TransactionPartner + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartneraffiliateprogram.rst b/docs/source/telegram.transactionpartneraffiliateprogram.rst new file mode 100644 index 00000000000..5d920dda37b --- /dev/null +++ b/docs/source/telegram.transactionpartneraffiliateprogram.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +TransactionPartnerAffiliateProgram +================================== + +.. currentmodule:: telegram + +.. autoclass:: TransactionPartnerAffiliateProgram + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartnerchat.rst b/docs/source/telegram.transactionpartnerchat.rst new file mode 100644 index 00000000000..7e58a8a3fc9 --- /dev/null +++ b/docs/source/telegram.transactionpartnerchat.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +TransactionPartnerChat +====================== + +.. currentmodule:: telegram + +.. autoclass:: TransactionPartnerChat + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartnerfragment.rst b/docs/source/telegram.transactionpartnerfragment.rst new file mode 100644 index 00000000000..63ff1c60d3a --- /dev/null +++ b/docs/source/telegram.transactionpartnerfragment.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +TransactionPartnerFragment +========================== + +.. currentmodule:: telegram + +.. autoclass:: TransactionPartnerFragment + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartnerother.rst b/docs/source/telegram.transactionpartnerother.rst new file mode 100644 index 00000000000..69e84249f58 --- /dev/null +++ b/docs/source/telegram.transactionpartnerother.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +TransactionPartnerOther +======================= + +.. currentmodule:: telegram + +.. autoclass:: TransactionPartnerOther + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartnertelegramads.rst b/docs/source/telegram.transactionpartnertelegramads.rst new file mode 100644 index 00000000000..3fb520cea42 --- /dev/null +++ b/docs/source/telegram.transactionpartnertelegramads.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +TransactionPartnerTelegramAds +============================= + +.. currentmodule:: telegram + +.. autoclass:: TransactionPartnerTelegramAds + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartnertelegramapi.rst b/docs/source/telegram.transactionpartnertelegramapi.rst new file mode 100644 index 00000000000..68c69d2b0fc --- /dev/null +++ b/docs/source/telegram.transactionpartnertelegramapi.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +TransactionPartnerTelegramApi +============================= + +.. currentmodule:: telegram + +.. autoclass:: TransactionPartnerTelegramApi + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartneruser.rst b/docs/source/telegram.transactionpartneruser.rst new file mode 100644 index 00000000000..32485d388d5 --- /dev/null +++ b/docs/source/telegram.transactionpartneruser.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +TransactionPartnerUser +====================== + +.. currentmodule:: telegram + +.. autoclass:: TransactionPartnerUser + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.uniquegift.rst b/docs/source/telegram.uniquegift.rst new file mode 100644 index 00000000000..a8fc12734bd --- /dev/null +++ b/docs/source/telegram.uniquegift.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +UniqueGift +========== + +.. currentmodule:: telegram + +.. autoclass:: UniqueGift + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.uniquegiftbackdrop.rst b/docs/source/telegram.uniquegiftbackdrop.rst new file mode 100644 index 00000000000..c5d5e9f8ee5 --- /dev/null +++ b/docs/source/telegram.uniquegiftbackdrop.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +UniqueGiftBackdrop +================== + +.. currentmodule:: telegram + +.. autoclass:: UniqueGiftBackdrop + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.uniquegiftbackdropcolors.rst b/docs/source/telegram.uniquegiftbackdropcolors.rst new file mode 100644 index 00000000000..8e35991e8cf --- /dev/null +++ b/docs/source/telegram.uniquegiftbackdropcolors.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +UniqueGiftBackdropColors +======================== + +.. currentmodule:: telegram + +.. autoclass:: UniqueGiftBackdropColors + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.uniquegiftcolors.rst b/docs/source/telegram.uniquegiftcolors.rst new file mode 100644 index 00000000000..3503f0b25ab --- /dev/null +++ b/docs/source/telegram.uniquegiftcolors.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +UniqueGiftColors +================ + +.. currentmodule:: telegram + +.. autoclass:: UniqueGiftColors + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.uniquegiftinfo.rst b/docs/source/telegram.uniquegiftinfo.rst new file mode 100644 index 00000000000..2af390ac9ec --- /dev/null +++ b/docs/source/telegram.uniquegiftinfo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +UniqueGiftInfo +============== + +.. currentmodule:: telegram + +.. autoclass:: UniqueGiftInfo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.uniquegiftmodel.rst b/docs/source/telegram.uniquegiftmodel.rst new file mode 100644 index 00000000000..eda48a8a19a --- /dev/null +++ b/docs/source/telegram.uniquegiftmodel.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +UniqueGiftModel +=============== + +.. currentmodule:: telegram + +.. autoclass:: UniqueGiftModel + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.uniquegiftsymbol.rst b/docs/source/telegram.uniquegiftsymbol.rst new file mode 100644 index 00000000000..4a9fbb25cd9 --- /dev/null +++ b/docs/source/telegram.uniquegiftsymbol.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +UniqueGiftSymbol +================ + +.. currentmodule:: telegram + +.. autoclass:: UniqueGiftSymbol + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.update.rst b/docs/source/telegram.update.rst new file mode 100644 index 00000000000..b84c853fc57 --- /dev/null +++ b/docs/source/telegram.update.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Update +====== + +.. currentmodule:: telegram + +.. autoclass:: Update + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.user.rst b/docs/source/telegram.user.rst new file mode 100644 index 00000000000..e7e74dcccdb --- /dev/null +++ b/docs/source/telegram.user.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +User +==== + +.. currentmodule:: telegram + +.. autoclass:: User + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.userchatboosts.rst b/docs/source/telegram.userchatboosts.rst new file mode 100644 index 00000000000..9dcdcbb3745 --- /dev/null +++ b/docs/source/telegram.userchatboosts.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +UserChatBoosts +============== + +.. currentmodule:: telegram + +.. autoclass:: UserChatBoosts + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.userprofileaudios.rst b/docs/source/telegram.userprofileaudios.rst new file mode 100644 index 00000000000..aedb1eed9ee --- /dev/null +++ b/docs/source/telegram.userprofileaudios.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +UserProfileAudios +================= + +.. currentmodule:: telegram + +.. autoclass:: UserProfileAudios + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.userprofilephotos.rst b/docs/source/telegram.userprofilephotos.rst new file mode 100644 index 00000000000..aba8abf82f6 --- /dev/null +++ b/docs/source/telegram.userprofilephotos.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +UserProfilePhotos +================= + +.. currentmodule:: telegram + +.. autoclass:: UserProfilePhotos + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.userrating.rst b/docs/source/telegram.userrating.rst new file mode 100644 index 00000000000..ab9ea6b0de2 --- /dev/null +++ b/docs/source/telegram.userrating.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +UserRating +========== + +.. currentmodule:: telegram + +.. autoclass:: UserRating + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.usersshared.rst b/docs/source/telegram.usersshared.rst new file mode 100644 index 00000000000..2facc573a32 --- /dev/null +++ b/docs/source/telegram.usersshared.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +UsersShared +=========== + +.. currentmodule:: telegram + +.. autoclass:: UsersShared + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.venue.rst b/docs/source/telegram.venue.rst new file mode 100644 index 00000000000..0bb332c435c --- /dev/null +++ b/docs/source/telegram.venue.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Venue +===== + +.. currentmodule:: telegram + +.. autoclass:: Venue + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.video.rst b/docs/source/telegram.video.rst new file mode 100644 index 00000000000..81cdf3b5a56 --- /dev/null +++ b/docs/source/telegram.video.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Video +===== + +.. currentmodule:: telegram + +.. autoclass:: Video + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.videochatended.rst b/docs/source/telegram.videochatended.rst new file mode 100644 index 00000000000..471b0baa4e1 --- /dev/null +++ b/docs/source/telegram.videochatended.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +VideoChatEnded +============== + +.. currentmodule:: telegram + +.. autoclass:: VideoChatEnded + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.videochatparticipantsinvited.rst b/docs/source/telegram.videochatparticipantsinvited.rst new file mode 100644 index 00000000000..306903989e3 --- /dev/null +++ b/docs/source/telegram.videochatparticipantsinvited.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +VideoChatParticipantsInvited +============================ + +.. currentmodule:: telegram + +.. autoclass:: VideoChatParticipantsInvited + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.videochatscheduled.rst b/docs/source/telegram.videochatscheduled.rst new file mode 100644 index 00000000000..090577889f7 --- /dev/null +++ b/docs/source/telegram.videochatscheduled.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +VideoChatScheduled +================== + +.. currentmodule:: telegram + +.. autoclass:: VideoChatScheduled + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.videochatstarted.rst b/docs/source/telegram.videochatstarted.rst new file mode 100644 index 00000000000..30f7f48aaf2 --- /dev/null +++ b/docs/source/telegram.videochatstarted.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +VideoChatStarted +================ + +.. currentmodule:: telegram + +.. autoclass:: VideoChatStarted + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.videonote.rst b/docs/source/telegram.videonote.rst new file mode 100644 index 00000000000..e40e63349bb --- /dev/null +++ b/docs/source/telegram.videonote.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +VideoNote +========= + +.. currentmodule:: telegram + +.. autoclass:: VideoNote + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.videoquality.rst b/docs/source/telegram.videoquality.rst new file mode 100644 index 00000000000..7e4fd5ae19b --- /dev/null +++ b/docs/source/telegram.videoquality.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +VideoQuality +============ + +.. currentmodule:: telegram + +.. autoclass:: VideoQuality + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.voice.rst b/docs/source/telegram.voice.rst new file mode 100644 index 00000000000..5819685136e --- /dev/null +++ b/docs/source/telegram.voice.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +Voice +===== + +.. currentmodule:: telegram + +.. autoclass:: Voice + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.warnings.rst b/docs/source/telegram.warnings.rst index 7af6887b1db..18d5f3a5143 100644 --- a/docs/source/telegram.warnings.rst +++ b/docs/source/telegram.warnings.rst @@ -1,6 +1,3 @@ -telegram.warnings Module -======================== +.. Autogenerated page: True -.. automodule:: telegram.warnings - :members: - :show-inheritance: +.. include:: telegram/warnings.rst diff --git a/docs/source/telegram.webappdata.rst b/docs/source/telegram.webappdata.rst new file mode 100644 index 00000000000..621762cf318 --- /dev/null +++ b/docs/source/telegram.webappdata.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +WebAppData +========== + +.. currentmodule:: telegram + +.. autoclass:: WebAppData + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.webappinfo.rst b/docs/source/telegram.webappinfo.rst new file mode 100644 index 00000000000..fb7a71d3484 --- /dev/null +++ b/docs/source/telegram.webappinfo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +WebAppInfo +========== + +.. currentmodule:: telegram + +.. autoclass:: WebAppInfo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.webhookinfo.rst b/docs/source/telegram.webhookinfo.rst new file mode 100644 index 00000000000..2c872daf89d --- /dev/null +++ b/docs/source/telegram.webhookinfo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +WebhookInfo +=========== + +.. currentmodule:: telegram + +.. autoclass:: WebhookInfo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.writeaccessallowed.rst b/docs/source/telegram.writeaccessallowed.rst new file mode 100644 index 00000000000..76a601c7da7 --- /dev/null +++ b/docs/source/telegram.writeaccessallowed.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: True + +WriteAccessAllowed +================== + +.. currentmodule:: telegram + +.. autoclass:: WriteAccessAllowed + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram/chat.rst b/docs/source/telegram/chat.rst new file mode 100644 index 00000000000..73d06a7a915 --- /dev/null +++ b/docs/source/telegram/chat.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: False + +Chat +==== + +.. Also lists methods of _ChatBase, but not the ones of TelegramObject +.. autoclass:: telegram.Chat + :members: + :show-inheritance: + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram/chatfullinfo.rst b/docs/source/telegram/chatfullinfo.rst new file mode 100644 index 00000000000..e048a4b59be --- /dev/null +++ b/docs/source/telegram/chatfullinfo.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: False + +ChatFullInfo +============ + +.. Also lists methods of _ChatBase, but not the ones of TelegramObject +.. autoclass:: telegram.ChatFullInfo + :members: + :show-inheritance: + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram/constants.rst b/docs/source/telegram/constants.rst new file mode 100644 index 00000000000..30ab75ce0b1 --- /dev/null +++ b/docs/source/telegram/constants.rst @@ -0,0 +1,10 @@ +.. Autogenerated page: False + +telegram.constants Module +========================= + +.. automodule:: telegram.constants + :members: + :show-inheritance: + :no-undoc-members: + :exclude-members: __format__, __new__, __repr__, __str__ diff --git a/docs/source/telegram/error.rst b/docs/source/telegram/error.rst new file mode 100644 index 00000000000..845d1785743 --- /dev/null +++ b/docs/source/telegram/error.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +telegram.error Module +===================== + +.. automodule:: telegram.error + :members: + :show-inheritance: diff --git a/docs/source/telegram/ext/applicationbuilder.rst b/docs/source/telegram/ext/applicationbuilder.rst new file mode 100644 index 00000000000..bc6c2abf3d5 --- /dev/null +++ b/docs/source/telegram/ext/applicationbuilder.rst @@ -0,0 +1,7 @@ +.. Autogenerated page: False + +ApplicationBuilder +================== + +.. autoclass:: telegram.ext.ApplicationBuilder + :members: diff --git a/docs/source/telegram/ext/callbackcontext.rst b/docs/source/telegram/ext/callbackcontext.rst new file mode 100644 index 00000000000..6eb15e17d3a --- /dev/null +++ b/docs/source/telegram/ext/callbackcontext.rst @@ -0,0 +1,7 @@ +.. Autogenerated page: False + +CallbackContext +=============== + +.. autoclass:: telegram.ext.CallbackContext + :members: diff --git a/docs/source/telegram/ext/extbot.rst b/docs/source/telegram/ext/extbot.rst new file mode 100644 index 00000000000..51c17893d97 --- /dev/null +++ b/docs/source/telegram/ext/extbot.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +ExtBot +====== + +.. autoclass:: telegram.ext.ExtBot + :show-inheritance: + :members: insert_callback_data, defaults, rate_limiter, initialize, shutdown, callback_data_cache diff --git a/docs/source/telegram/ext/filters.rst b/docs/source/telegram/ext/filters.rst new file mode 100644 index 00000000000..09658ee2056 --- /dev/null +++ b/docs/source/telegram/ext/filters.rst @@ -0,0 +1,13 @@ +.. Autogenerated page: False + +filters Module +============== + +.. :bysource: since e.g filters.CHAT is much above filters.Chat() in the docs when it shouldn't. + The classes in `filters.py` are sorted alphabetically such that :bysource: still is readable + +.. automodule:: telegram.ext.filters + :inherited-members: BaseFilter, MessageFilter, UpdateFilter, object + :members: + :show-inheritance: + :member-order: bysource diff --git a/docs/source/telegram/ext/index.rst b/docs/source/telegram/ext/index.rst new file mode 100644 index 00000000000..30ed00a9f07 --- /dev/null +++ b/docs/source/telegram/ext/index.rst @@ -0,0 +1,6 @@ +.. Autogenerated page: False + +telegram.ext package +==================== + +.. automodule:: telegram.ext diff --git a/docs/source/telegram/ext/persistenceinput.rst b/docs/source/telegram/ext/persistenceinput.rst new file mode 100644 index 00000000000..e83b5beb83b --- /dev/null +++ b/docs/source/telegram/ext/persistenceinput.rst @@ -0,0 +1,7 @@ +.. Autogenerated page: False + +PersistenceInput +================ + +.. autoclass:: telegram.ext.PersistenceInput + :show-inheritance: diff --git a/docs/source/telegram/helpers.rst b/docs/source/telegram/helpers.rst new file mode 100644 index 00000000000..9cf64e728b5 --- /dev/null +++ b/docs/source/telegram/helpers.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +telegram.helpers Module +======================= + +.. automodule:: telegram.helpers + :members: + :show-inheritance: diff --git a/docs/source/telegram/index.rst b/docs/source/telegram/index.rst new file mode 100644 index 00000000000..aabff46fcf3 --- /dev/null +++ b/docs/source/telegram/index.rst @@ -0,0 +1,13 @@ +.. Autogenerated page: False + +telegram package +================ + +Version Constants +----------------- + +.. automodule:: telegram + :members: __version__, __version_info__, __bot_api_version__, __bot_api_version_info__ + +Classes in this package +----------------------- diff --git a/docs/source/telegram/inputpollmedia.rst b/docs/source/telegram/inputpollmedia.rst new file mode 100644 index 00000000000..020a8e5191b --- /dev/null +++ b/docs/source/telegram/inputpollmedia.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +InputPollMedia +============== + +.. versionadded:: NEXT.VERSION + +.. autoclass:: telegram.InputPollMedia diff --git a/docs/source/telegram/inputpolloptionmedia.rst b/docs/source/telegram/inputpolloptionmedia.rst new file mode 100644 index 00000000000..0fbb79b4fd6 --- /dev/null +++ b/docs/source/telegram/inputpolloptionmedia.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +InputPollOptionMedia +==================== + +.. versionadded:: NEXT.VERSION + +.. autoclass:: telegram.InputPollOptionMedia diff --git a/docs/source/telegram/request/index.rst b/docs/source/telegram/request/index.rst new file mode 100644 index 00000000000..c4f1bff63c6 --- /dev/null +++ b/docs/source/telegram/request/index.rst @@ -0,0 +1,6 @@ +.. Autogenerated page: False + +telegram.request Module +======================= + +.. versionadded:: 20.0 diff --git a/docs/source/telegram/warnings.rst b/docs/source/telegram/warnings.rst new file mode 100644 index 00000000000..5646c36a4a6 --- /dev/null +++ b/docs/source/telegram/warnings.rst @@ -0,0 +1,8 @@ +.. Autogenerated page: False + +telegram.warnings Module +======================== + +.. automodule:: telegram.warnings + :members: + :show-inheritance: diff --git a/docs/source/telegram_auxil.rst b/docs/source/telegram_auxil.rst index 19b26d609fa..adfc6a576cd 100644 --- a/docs/source/telegram_auxil.rst +++ b/docs/source/telegram_auxil.rst @@ -1,11 +1,3 @@ -Auxiliary modules -================= +.. Autogenerated page: True -.. toctree:: - :titlesonly: - - telegram.constants - telegram.error - telegram.helpers - telegram.request - telegram.warnings +.. include:: telegram_auxil/index.rst diff --git a/docs/source/telegram_auxil/index.rst b/docs/source/telegram_auxil/index.rst new file mode 100644 index 00000000000..6c35f89f457 --- /dev/null +++ b/docs/source/telegram_auxil/index.rst @@ -0,0 +1,4 @@ +.. Autogenerated page: False + +Auxiliary modules +================= From 08c768e3b2831b81e4e29fd9970969fbd01c1872 Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Tue, 4 Aug 2026 04:22:03 -0400 Subject: [PATCH 3/4] Only use examples/, remove autogen files for examples in source/ Also changes the path from the . to / --- README.rst | 2 +- docs/auxil/api_docs.py | 6 +- docs/source/conf.py | 4 +- .../examples.arbitrarycallbackdatabot.rst | 3 - docs/source/examples.chatmemberbot.rst | 3 - docs/source/examples.contexttypesbot.rst | 3 - docs/source/examples.conversationbot.rst | 3 - docs/source/examples.conversationbot2.rst | 3 - docs/source/examples.customwebhookbot.rst | 3 - docs/source/examples.deeplinking.rst | 3 - docs/source/examples.echobot.rst | 3 - docs/source/examples.errorhandlerbot.rst | 3 - docs/source/examples.inlinebot.rst | 3 - docs/source/examples.inlinekeyboard.rst | 3 - docs/source/examples.inlinekeyboard2.rst | 3 - .../source/examples.nestedconversationbot.rst | 3 - docs/source/examples.passportbot.rst | 3 - docs/source/examples.paymentbot.rst | 3 - .../examples.persistentconversationbot.rst | 3 - docs/source/examples.pollbot.rst | 3 - docs/source/examples.rawapibot.rst | 3 - docs/source/examples.rst | 3 - docs/source/examples.timerbot.rst | 3 - docs/source/examples.webappbot.rst | 3 - .../examples/arbitrarycallbackdatabot.rst | 2 +- docs/source/examples/chatmemberbot.rst | 2 +- docs/source/examples/contexttypesbot.rst | 2 +- docs/source/examples/conversationbot.rst | 4 +- docs/source/examples/conversationbot2.rst | 4 +- docs/source/examples/customwebhookbot.rst | 8 +- docs/source/examples/deeplinking.rst | 2 +- docs/source/examples/echobot.rst | 2 +- docs/source/examples/errorhandlerbot.rst | 2 +- docs/source/examples/index.rst | 82 +++++++++---------- docs/source/examples/inlinebot.rst | 2 +- docs/source/examples/inlinekeyboard.rst | 2 +- docs/source/examples/inlinekeyboard2.rst | 2 +- .../source/examples/nestedconversationbot.rst | 4 +- docs/source/examples/passportbot.rst | 4 +- docs/source/examples/paymentbot.rst | 2 +- .../examples/persistentconversationbot.rst | 2 +- docs/source/examples/pollbot.rst | 2 +- docs/source/examples/rawapibot.rst | 2 +- docs/source/examples/timerbot.rst | 2 +- docs/source/examples/webappbot.rst | 4 +- docs/source/index.rst | 2 +- docs/substitutions/global.rst | 2 +- examples/README.md | 4 +- src/telegram/_bot.py | 4 +- src/telegram/_chatmember.py | 2 +- src/telegram/_chatmemberupdated.py | 2 +- src/telegram/_inline/inlinekeyboardbutton.py | 4 +- src/telegram/_inline/inlinekeyboardmarkup.py | 4 +- src/telegram/_inline/inlinequeryresult.py | 2 +- .../_inline/inlinequeryresultarticle.py | 2 +- .../_inline/inputtextmessagecontent.py | 2 +- src/telegram/_keyboardbuttonpolltype.py | 2 +- src/telegram/_message.py | 2 +- src/telegram/_payment/labeledprice.py | 2 +- src/telegram/_payment/shippingoption.py | 2 +- src/telegram/_poll.py | 2 +- src/telegram/_replykeyboardmarkup.py | 4 +- src/telegram/_replykeyboardremove.py | 4 +- src/telegram/_update.py | 2 +- src/telegram/_webappdata.py | 2 +- src/telegram/_webappinfo.py | 2 +- src/telegram/error.py | 4 +- src/telegram/ext/_application.py | 4 +- src/telegram/ext/_applicationbuilder.py | 10 +-- src/telegram/ext/_callbackcontext.py | 4 +- src/telegram/ext/_callbackdatacache.py | 4 +- src/telegram/ext/_contexttypes.py | 2 +- src/telegram/ext/_extbot.py | 4 +- .../ext/_handlers/chatmemberhandler.py | 2 +- src/telegram/ext/_handlers/commandhandler.py | 4 +- .../ext/_handlers/conversationhandler.py | 10 +-- .../ext/_handlers/inlinequeryhandler.py | 2 +- .../ext/_handlers/pollanswerhandler.py | 2 +- src/telegram/ext/_handlers/pollhandler.py | 2 +- .../ext/_handlers/precheckoutqueryhandler.py | 2 +- .../ext/_handlers/shippingqueryhandler.py | 2 +- src/telegram/ext/_jobqueue.py | 2 +- src/telegram/ext/_picklepersistence.py | 2 +- src/telegram/helpers.py | 2 +- 84 files changed, 134 insertions(+), 197 deletions(-) delete mode 100644 docs/source/examples.arbitrarycallbackdatabot.rst delete mode 100644 docs/source/examples.chatmemberbot.rst delete mode 100644 docs/source/examples.contexttypesbot.rst delete mode 100644 docs/source/examples.conversationbot.rst delete mode 100644 docs/source/examples.conversationbot2.rst delete mode 100644 docs/source/examples.customwebhookbot.rst delete mode 100644 docs/source/examples.deeplinking.rst delete mode 100644 docs/source/examples.echobot.rst delete mode 100644 docs/source/examples.errorhandlerbot.rst delete mode 100644 docs/source/examples.inlinebot.rst delete mode 100644 docs/source/examples.inlinekeyboard.rst delete mode 100644 docs/source/examples.inlinekeyboard2.rst delete mode 100644 docs/source/examples.nestedconversationbot.rst delete mode 100644 docs/source/examples.passportbot.rst delete mode 100644 docs/source/examples.paymentbot.rst delete mode 100644 docs/source/examples.persistentconversationbot.rst delete mode 100644 docs/source/examples.pollbot.rst delete mode 100644 docs/source/examples.rawapibot.rst delete mode 100644 docs/source/examples.rst delete mode 100644 docs/source/examples.timerbot.rst delete mode 100644 docs/source/examples.webappbot.rst diff --git a/README.rst b/README.rst index 44cbe11f12e..9434eae5a65 100644 --- a/README.rst +++ b/README.rst @@ -182,7 +182,7 @@ Resources - The `package documentation `_ is the technical reference for ``python-telegram-bot``. It contains descriptions of all available classes, modules, methods and arguments as well as the `changelog `_. - The `wiki `_ is home to number of more elaborate introductions of the different features of ``python-telegram-bot`` and other useful resources that go beyond the technical documentation. -- Our `examples section `_ contains several examples that showcase the different features of both the Bot API and ``python-telegram-bot``. +- Our `examples section `_ contains several examples that showcase the different features of both the Bot API and ``python-telegram-bot``. Even if it is not your approach for learning, please take a look at ``echobot.py``. It is the de facto base for most of the bots out there. The code for these examples is released to the public domain, so you can start by grabbing the code and building on top of it. - The `official Telegram Bot API documentation `_ is of course always worth a read. diff --git a/docs/auxil/api_docs.py b/docs/auxil/api_docs.py index 10af478b023..e878cd0d1a0 100644 --- a/docs/auxil/api_docs.py +++ b/docs/auxil/api_docs.py @@ -23,7 +23,7 @@ sources before discovery. During ``source-read``, it adds the current navigation in memory, so RST files never contain generated class lists. -Maintained sources live in module-shaped directories for readability. Small generated wrappers +Maintained API sources live in module-shaped directories for readability. Small generated wrappers preserve the historic dotted document names and URLs. Generated files remain on disk, and are only rewritten when their content changes, so Sphinx's normal mtime cache remains effective. @@ -65,7 +65,7 @@ class MaintainedFragment(NamedTuple): GENERATED_MARKER: Final[str] = ".. Autogenerated page: True" MAINTAINED_MARKER: Final[str] = ".. Autogenerated page: False" -FRAGMENT_DIRECTORIES: Final[tuple[str, ...]] = ("examples", "telegram", "telegram_auxil") +API_FRAGMENT_DIRECTORIES: Final[tuple[str, ...]] = ("telegram", "telegram_auxil") API_MODULES: Final[tuple[ModuleType, ...]] = (telegram, telegram.ext, telegram.request) # The key is the Sphinx document name. The value supplies its title and the internal module @@ -292,7 +292,7 @@ def _discover_maintained_fragments(source_dir: Path) -> dict[str, MaintainedFrag unmarked_fragments: list[Path] = [] # Scan only the module-shaped directories owned by this extension. - for directory in FRAGMENT_DIRECTORIES: + for directory in API_FRAGMENT_DIRECTORIES: directory_path: Path = source_dir / directory fragment_paths: list[Path] = sorted(directory_path.rglob("*.rst")) diff --git a/docs/source/conf.py b/docs/source/conf.py index e1eb31219b7..f8e3259cbd5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -82,8 +82,8 @@ # You can specify multiple suffix as a list of string: source_suffix = ".rst" -# These maintained fragments are included by generated documents with the historic dotted names. -exclude_patterns = ["examples/**", "telegram/**", "telegram_auxil/**"] +# API fragments are included by generated dotted-name wrappers. Example pages are read in place. +exclude_patterns = ["telegram/**", "telegram_auxil/**"] # The master toctree document. master_doc = "index" diff --git a/docs/source/examples.arbitrarycallbackdatabot.rst b/docs/source/examples.arbitrarycallbackdatabot.rst deleted file mode 100644 index 56f3b4b2ca7..00000000000 --- a/docs/source/examples.arbitrarycallbackdatabot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/arbitrarycallbackdatabot.rst diff --git a/docs/source/examples.chatmemberbot.rst b/docs/source/examples.chatmemberbot.rst deleted file mode 100644 index 42f1a62c332..00000000000 --- a/docs/source/examples.chatmemberbot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/chatmemberbot.rst diff --git a/docs/source/examples.contexttypesbot.rst b/docs/source/examples.contexttypesbot.rst deleted file mode 100644 index 056de3ffc0d..00000000000 --- a/docs/source/examples.contexttypesbot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/contexttypesbot.rst diff --git a/docs/source/examples.conversationbot.rst b/docs/source/examples.conversationbot.rst deleted file mode 100644 index 283023ac89b..00000000000 --- a/docs/source/examples.conversationbot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/conversationbot.rst diff --git a/docs/source/examples.conversationbot2.rst b/docs/source/examples.conversationbot2.rst deleted file mode 100644 index 66404c47eaf..00000000000 --- a/docs/source/examples.conversationbot2.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/conversationbot2.rst diff --git a/docs/source/examples.customwebhookbot.rst b/docs/source/examples.customwebhookbot.rst deleted file mode 100644 index 8303b3d7228..00000000000 --- a/docs/source/examples.customwebhookbot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/customwebhookbot.rst diff --git a/docs/source/examples.deeplinking.rst b/docs/source/examples.deeplinking.rst deleted file mode 100644 index 1863415ad34..00000000000 --- a/docs/source/examples.deeplinking.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/deeplinking.rst diff --git a/docs/source/examples.echobot.rst b/docs/source/examples.echobot.rst deleted file mode 100644 index 7170f4d8583..00000000000 --- a/docs/source/examples.echobot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/echobot.rst diff --git a/docs/source/examples.errorhandlerbot.rst b/docs/source/examples.errorhandlerbot.rst deleted file mode 100644 index c58a1338941..00000000000 --- a/docs/source/examples.errorhandlerbot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/errorhandlerbot.rst diff --git a/docs/source/examples.inlinebot.rst b/docs/source/examples.inlinebot.rst deleted file mode 100644 index 8329f3acfdf..00000000000 --- a/docs/source/examples.inlinebot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/inlinebot.rst diff --git a/docs/source/examples.inlinekeyboard.rst b/docs/source/examples.inlinekeyboard.rst deleted file mode 100644 index 668eb13adf0..00000000000 --- a/docs/source/examples.inlinekeyboard.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/inlinekeyboard.rst diff --git a/docs/source/examples.inlinekeyboard2.rst b/docs/source/examples.inlinekeyboard2.rst deleted file mode 100644 index 828516825f6..00000000000 --- a/docs/source/examples.inlinekeyboard2.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/inlinekeyboard2.rst diff --git a/docs/source/examples.nestedconversationbot.rst b/docs/source/examples.nestedconversationbot.rst deleted file mode 100644 index 127956c09c1..00000000000 --- a/docs/source/examples.nestedconversationbot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/nestedconversationbot.rst diff --git a/docs/source/examples.passportbot.rst b/docs/source/examples.passportbot.rst deleted file mode 100644 index a19badb2335..00000000000 --- a/docs/source/examples.passportbot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/passportbot.rst diff --git a/docs/source/examples.paymentbot.rst b/docs/source/examples.paymentbot.rst deleted file mode 100644 index 2cb1b5221ec..00000000000 --- a/docs/source/examples.paymentbot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/paymentbot.rst diff --git a/docs/source/examples.persistentconversationbot.rst b/docs/source/examples.persistentconversationbot.rst deleted file mode 100644 index 81cb04fa9a7..00000000000 --- a/docs/source/examples.persistentconversationbot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/persistentconversationbot.rst diff --git a/docs/source/examples.pollbot.rst b/docs/source/examples.pollbot.rst deleted file mode 100644 index 228990a78a3..00000000000 --- a/docs/source/examples.pollbot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/pollbot.rst diff --git a/docs/source/examples.rawapibot.rst b/docs/source/examples.rawapibot.rst deleted file mode 100644 index 74afa88d744..00000000000 --- a/docs/source/examples.rawapibot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/rawapibot.rst diff --git a/docs/source/examples.rst b/docs/source/examples.rst deleted file mode 100644 index e5e84cb216d..00000000000 --- a/docs/source/examples.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/index.rst diff --git a/docs/source/examples.timerbot.rst b/docs/source/examples.timerbot.rst deleted file mode 100644 index f803991271d..00000000000 --- a/docs/source/examples.timerbot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/timerbot.rst diff --git a/docs/source/examples.webappbot.rst b/docs/source/examples.webappbot.rst deleted file mode 100644 index ebe452f7130..00000000000 --- a/docs/source/examples.webappbot.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. Autogenerated page: True - -.. include:: examples/webappbot.rst diff --git a/docs/source/examples/arbitrarycallbackdatabot.rst b/docs/source/examples/arbitrarycallbackdatabot.rst index 9f2f73c74ba..328dd937097 100644 --- a/docs/source/examples/arbitrarycallbackdatabot.rst +++ b/docs/source/examples/arbitrarycallbackdatabot.rst @@ -3,6 +3,6 @@ ``arbitrarycallbackdatabot.py`` =============================== -.. literalinclude:: ../../examples/arbitrarycallbackdatabot.py +.. literalinclude:: ../../../examples/arbitrarycallbackdatabot.py :language: python :linenos: diff --git a/docs/source/examples/chatmemberbot.rst b/docs/source/examples/chatmemberbot.rst index fa94c43c09b..2971b79f515 100644 --- a/docs/source/examples/chatmemberbot.rst +++ b/docs/source/examples/chatmemberbot.rst @@ -3,6 +3,6 @@ ``chatmemberbot.py`` ==================== -.. literalinclude:: ../../examples/chatmemberbot.py +.. literalinclude:: ../../../examples/chatmemberbot.py :language: python :linenos: diff --git a/docs/source/examples/contexttypesbot.rst b/docs/source/examples/contexttypesbot.rst index f0a8efd2c64..f67ccf0ca0b 100644 --- a/docs/source/examples/contexttypesbot.rst +++ b/docs/source/examples/contexttypesbot.rst @@ -3,6 +3,6 @@ ``contexttypesbot.py`` ====================== -.. literalinclude:: ../../examples/contexttypesbot.py +.. literalinclude:: ../../../examples/contexttypesbot.py :language: python :linenos: diff --git a/docs/source/examples/conversationbot.rst b/docs/source/examples/conversationbot.rst index 11210542c99..ab3206d66d8 100644 --- a/docs/source/examples/conversationbot.rst +++ b/docs/source/examples/conversationbot.rst @@ -3,7 +3,7 @@ ``conversationbot.py`` ====================== -.. literalinclude:: ../../examples/conversationbot.py +.. literalinclude:: ../../../examples/conversationbot.py :language: python :linenos: @@ -12,4 +12,4 @@ State Diagram ------------- -.. mermaid:: ../../examples/conversationbot.mmd +.. mermaid:: ../../../examples/conversationbot.mmd diff --git a/docs/source/examples/conversationbot2.rst b/docs/source/examples/conversationbot2.rst index f9251efe8e1..7dc9640d401 100644 --- a/docs/source/examples/conversationbot2.rst +++ b/docs/source/examples/conversationbot2.rst @@ -3,7 +3,7 @@ ``conversationbot2.py`` ======================= -.. literalinclude:: ../../examples/conversationbot2.py +.. literalinclude:: ../../../examples/conversationbot2.py :language: python :linenos: @@ -12,4 +12,4 @@ State Diagram ------------- -.. mermaid:: ../../examples/conversationbot2.mmd +.. mermaid:: ../../../examples/conversationbot2.mmd diff --git a/docs/source/examples/customwebhookbot.rst b/docs/source/examples/customwebhookbot.rst index bc37a2460f1..c219213757c 100644 --- a/docs/source/examples/customwebhookbot.rst +++ b/docs/source/examples/customwebhookbot.rst @@ -21,24 +21,24 @@ You can select your preferred framework by opening one of the tabs above the cod .. tab:: ``starlette`` - .. literalinclude:: ../../examples/customwebhookbot/starlettebot.py + .. literalinclude:: ../../../examples/customwebhookbot/starlettebot.py :language: python :linenos: .. tab:: ``flask`` - .. literalinclude:: ../../examples/customwebhookbot/flaskbot.py + .. literalinclude:: ../../../examples/customwebhookbot/flaskbot.py :language: python :linenos: .. tab:: ``quart`` - .. literalinclude:: ../../examples/customwebhookbot/quartbot.py + .. literalinclude:: ../../../examples/customwebhookbot/quartbot.py :language: python :linenos: .. tab:: ``Django`` - .. literalinclude:: ../../examples/customwebhookbot/djangobot.py + .. literalinclude:: ../../../examples/customwebhookbot/djangobot.py :language: python :linenos: diff --git a/docs/source/examples/deeplinking.rst b/docs/source/examples/deeplinking.rst index a286ad1e573..15035531b58 100644 --- a/docs/source/examples/deeplinking.rst +++ b/docs/source/examples/deeplinking.rst @@ -3,6 +3,6 @@ ``deeplinking.py`` ================== -.. literalinclude:: ../../examples/deeplinking.py +.. literalinclude:: ../../../examples/deeplinking.py :language: python :linenos: diff --git a/docs/source/examples/echobot.rst b/docs/source/examples/echobot.rst index db246de4ebe..4951b1e8594 100644 --- a/docs/source/examples/echobot.rst +++ b/docs/source/examples/echobot.rst @@ -3,6 +3,6 @@ ``echobot.py`` ============== -.. literalinclude:: ../../examples/echobot.py +.. literalinclude:: ../../../examples/echobot.py :language: python :linenos: diff --git a/docs/source/examples/errorhandlerbot.rst b/docs/source/examples/errorhandlerbot.rst index 7d3db4c0bce..c67a85dcd37 100644 --- a/docs/source/examples/errorhandlerbot.rst +++ b/docs/source/examples/errorhandlerbot.rst @@ -3,6 +3,6 @@ ``errorhandlerbot.py`` ====================== -.. literalinclude:: ../../examples/errorhandlerbot.py +.. literalinclude:: ../../../examples/errorhandlerbot.py :language: python :linenos: diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst index 47efb05478f..a2af26f439a 100644 --- a/docs/source/examples/index.rst +++ b/docs/source/examples/index.rst @@ -8,7 +8,7 @@ In this section we display small examples to show what a bot written with Some bots focus on one specific aspect of the Telegram Bot API while others focus on one of the mechanics of this library. Except for the -:any:`examples.rawapibot` example, they all use the high-level +:doc:`rawapibot` example, they all use the high-level framework this library provides with the :mod:`telegram.ext` submodule. @@ -24,14 +24,14 @@ local variable in those callbacks. However, since these are examples and not having a name for that argument confuses beginners, we decided to have it present. -:any:`examples.echobot` +:doc:`echobot` ----------------------- This is probably the base for most of the bots made with ``python-telegram-bot``. It simply replies to each text message with a message that contains the same text. -:any:`examples.timerbot` +:doc:`timerbot` ------------------------ This bot uses the @@ -43,7 +43,7 @@ also cancel the timer by sending ``/unset``. To learn more about the ``JobQueue``, read `this wiki article `__. Note: To use ``JobQueue``, you must install PTB via ``pip install "python-telegram-bot[job-queue]"`` -:any:`examples.conversationbot` +:doc:`conversationbot` ------------------------------- A common task for a bot is to ask information from the user. In v5.0 of @@ -53,14 +53,14 @@ for that exact purpose. This example uses it to retrieve user-information in a conversation-like style. To get a better understanding, take a look at the :ref:`state diagram `. -:any:`examples.conversationbot2` +:doc:`conversationbot2` -------------------------------- A more complex example of a bot that uses the ``ConversationHandler``. It is also more confusing. Good thing there is a :ref:`fancy state diagram `. for this one, too! -:any:`examples.nestedconversationbot` +:doc:`nestedconversationbot` ------------------------------------- An even more complex example of a bot that uses the nested @@ -70,45 +70,45 @@ gives a good impression on how to work with them. Of course, there is a :ref:`fancy state diagram ` for this example, too! -:any:`examples.persistentconversationbot` +:doc:`persistentconversationbot` ----------------------------------------- A basic example of a bot store conversation state and user_data over multiple restarts. -:any:`examples.inlinekeyboard` +:doc:`inlinekeyboard` ------------------------------ This example sheds some light on inline keyboards, callback queries and message editing. A wiki site explaining this examples lives `here `__. -:any:`examples.inlinekeyboard2` +:doc:`inlinekeyboard2` ------------------------------- A more complex example about inline keyboards, callback queries and message editing. This example showcases how an interactive menu could be build using inline keyboards. -:any:`examples.deeplinking` +:doc:`deeplinking` --------------------------- A basic example on how to use deeplinking with inline keyboards. -:any:`examples.inlinebot` +:doc:`inlinebot` ------------------------- A basic example of an `inline bot `__. Don’t forget to enable inline mode with `@BotFather `_. -:any:`examples.pollbot` +:doc:`pollbot` ----------------------- This example sheds some light on polls, poll answers and the corresponding handlers. -:any:`examples.passportbot` +:doc:`passportbot` --------------------------- A basic example of a bot that can accept passports. Use in combination @@ -119,24 +119,24 @@ Don’t forget to enable and configure payments with on Telegram passports in PTB. Note: To use Telegram Passport, you must install PTB via ``pip install "python-telegram-bot[passport]"`` -:any:`examples.paymentbot` +:doc:`paymentbot` -------------------------- A basic example of a bot that can accept payments. Don’t forget to enable and configure payments with `@BotFather `_. -:any:`examples.errorhandlerbot` +:doc:`errorhandlerbot` ------------------------------- A basic example on how to set up a custom error handler. -:any:`examples.chatmemberbot` +:doc:`chatmemberbot` ----------------------------- A basic example on how ``(my_)chat_member`` updates can be used. -:any:`examples.webappbot` +:doc:`webappbot` ------------------------- A basic example of how `Telegram @@ -148,19 +148,19 @@ don’t need to host it yourself. Uses the user interface that is hard to achieve with native Telegram functionality. -:any:`examples.contexttypesbot` +:doc:`contexttypesbot` ------------------------------- This example showcases how ``telegram.ext.ContextTypes`` can be used to customize the ``context`` argument of handler and job callbacks. -:any:`examples.customwebhookbot` +:doc:`customwebhookbot` -------------------------------- This example showcases how a custom webhook setup can be used in combination with ``telegram.ext.Application``. -:any:`examples.arbitrarycallbackdatabot` +:doc:`arbitrarycallbackdatabot` ---------------------------------------- This example showcases how PTBs “arbitrary callback data” feature can be @@ -170,28 +170,28 @@ Note: To use arbitrary callback data, you must install PTB via ``pip install "py Pure API -------- -The :any:`examples.rawapibot` example example uses only the pure, “bare-metal” API wrapper. +The :doc:`rawapibot` example example uses only the pure, “bare-metal” API wrapper. .. toctree:: :hidden: - examples.arbitrarycallbackdatabot - examples.chatmemberbot - examples.contexttypesbot - examples.conversationbot - examples.conversationbot2 - examples.customwebhookbot - examples.deeplinking - examples.echobot - examples.errorhandlerbot - examples.inlinebot - examples.inlinekeyboard - examples.inlinekeyboard2 - examples.nestedconversationbot - examples.passportbot - examples.paymentbot - examples.persistentconversationbot - examples.pollbot - examples.rawapibot - examples.timerbot - examples.webappbot + arbitrarycallbackdatabot + chatmemberbot + contexttypesbot + conversationbot + conversationbot2 + customwebhookbot + deeplinking + echobot + errorhandlerbot + inlinebot + inlinekeyboard + inlinekeyboard2 + nestedconversationbot + passportbot + paymentbot + persistentconversationbot + pollbot + rawapibot + timerbot + webappbot diff --git a/docs/source/examples/inlinebot.rst b/docs/source/examples/inlinebot.rst index 518546bf78e..dc64eae587c 100644 --- a/docs/source/examples/inlinebot.rst +++ b/docs/source/examples/inlinebot.rst @@ -3,6 +3,6 @@ ``inlinebot.py`` ================ -.. literalinclude:: ../../examples/inlinebot.py +.. literalinclude:: ../../../examples/inlinebot.py :language: python :linenos: diff --git a/docs/source/examples/inlinekeyboard.rst b/docs/source/examples/inlinekeyboard.rst index e9b26278dc6..8fb3a283a3f 100644 --- a/docs/source/examples/inlinekeyboard.rst +++ b/docs/source/examples/inlinekeyboard.rst @@ -3,6 +3,6 @@ ``inlinekeyboard.py`` ===================== -.. literalinclude:: ../../examples/inlinekeyboard.py +.. literalinclude:: ../../../examples/inlinekeyboard.py :language: python :linenos: diff --git a/docs/source/examples/inlinekeyboard2.rst b/docs/source/examples/inlinekeyboard2.rst index 15d0d25cd4b..cba14c89c1a 100644 --- a/docs/source/examples/inlinekeyboard2.rst +++ b/docs/source/examples/inlinekeyboard2.rst @@ -3,6 +3,6 @@ ``inlinekeyboard2.py`` ====================== -.. literalinclude:: ../../examples/inlinekeyboard2.py +.. literalinclude:: ../../../examples/inlinekeyboard2.py :language: python :linenos: diff --git a/docs/source/examples/nestedconversationbot.rst b/docs/source/examples/nestedconversationbot.rst index 4e32d8c3126..c497c4a5286 100644 --- a/docs/source/examples/nestedconversationbot.rst +++ b/docs/source/examples/nestedconversationbot.rst @@ -3,7 +3,7 @@ ``nestedconversationbot.py`` ============================ -.. literalinclude:: ../../examples/nestedconversationbot.py +.. literalinclude:: ../../../examples/nestedconversationbot.py :language: python :linenos: @@ -12,4 +12,4 @@ State Diagram ------------- -.. mermaid:: ../../examples/nestedconversationbot.mmd +.. mermaid:: ../../../examples/nestedconversationbot.mmd diff --git a/docs/source/examples/passportbot.rst b/docs/source/examples/passportbot.rst index 938ad7f537d..9520f78ae5c 100644 --- a/docs/source/examples/passportbot.rst +++ b/docs/source/examples/passportbot.rst @@ -3,7 +3,7 @@ ``passportbot.py`` ================== -.. literalinclude:: ../../examples/passportbot.py +.. literalinclude:: ../../../examples/passportbot.py :language: python :linenos: @@ -12,6 +12,6 @@ HTML Page --------- -.. literalinclude:: ../../examples/passportbot.html +.. literalinclude:: ../../../examples/passportbot.html :language: html :linenos: diff --git a/docs/source/examples/paymentbot.rst b/docs/source/examples/paymentbot.rst index 0f296409a13..d6af2135ec6 100644 --- a/docs/source/examples/paymentbot.rst +++ b/docs/source/examples/paymentbot.rst @@ -3,6 +3,6 @@ ``paymentbot.py`` ================= -.. literalinclude:: ../../examples/paymentbot.py +.. literalinclude:: ../../../examples/paymentbot.py :language: python :linenos: diff --git a/docs/source/examples/persistentconversationbot.rst b/docs/source/examples/persistentconversationbot.rst index f632a6bfcb3..ecc2c8d0844 100644 --- a/docs/source/examples/persistentconversationbot.rst +++ b/docs/source/examples/persistentconversationbot.rst @@ -3,6 +3,6 @@ ``persistentconversationbot.py`` ================================ -.. literalinclude:: ../../examples/persistentconversationbot.py +.. literalinclude:: ../../../examples/persistentconversationbot.py :language: python :linenos: diff --git a/docs/source/examples/pollbot.rst b/docs/source/examples/pollbot.rst index d14f5c73ec9..3da53c712cb 100644 --- a/docs/source/examples/pollbot.rst +++ b/docs/source/examples/pollbot.rst @@ -3,6 +3,6 @@ ``pollbot.py`` ============== -.. literalinclude:: ../../examples/pollbot.py +.. literalinclude:: ../../../examples/pollbot.py :language: python :linenos: diff --git a/docs/source/examples/rawapibot.rst b/docs/source/examples/rawapibot.rst index 08977e3057a..b4fbd43db6c 100644 --- a/docs/source/examples/rawapibot.rst +++ b/docs/source/examples/rawapibot.rst @@ -7,6 +7,6 @@ This example uses only the pure, "bare-metal" API wrapper. -.. literalinclude:: ../../examples/rawapibot.py +.. literalinclude:: ../../../examples/rawapibot.py :language: python :linenos: diff --git a/docs/source/examples/timerbot.rst b/docs/source/examples/timerbot.rst index 3c4b8ff73d4..d3a4578abf8 100644 --- a/docs/source/examples/timerbot.rst +++ b/docs/source/examples/timerbot.rst @@ -3,6 +3,6 @@ ``timerbot.py`` =============== -.. literalinclude:: ../../examples/timerbot.py +.. literalinclude:: ../../../examples/timerbot.py :language: python :linenos: diff --git a/docs/source/examples/webappbot.rst b/docs/source/examples/webappbot.rst index a51a1e4e0d2..782cc9198f1 100644 --- a/docs/source/examples/webappbot.rst +++ b/docs/source/examples/webappbot.rst @@ -3,7 +3,7 @@ ``webappbot.py`` ================ -.. literalinclude:: ../../examples/webappbot.py +.. literalinclude:: ../../../examples/webappbot.py :language: python :linenos: @@ -12,6 +12,6 @@ HTML Page --------- -.. literalinclude:: ../../examples/webappbot.html +.. literalinclude:: ../../../examples/webappbot.html :language: html :linenos: diff --git a/docs/source/index.rst b/docs/source/index.rst index f8aa9e7b647..053e5771435 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -32,7 +32,7 @@ This is just here to get furo to display the right sidebar. :hidden: :caption: Resources - examples + examples/index Wiki .. toctree:: diff --git a/docs/substitutions/global.rst b/docs/substitutions/global.rst index f1bad363716..a079bc812a6 100644 --- a/docs/substitutions/global.rst +++ b/docs/substitutions/global.rst @@ -56,7 +56,7 @@ .. |datetime_localization| replace:: The default timezone of the bot is used for localization, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is used. -.. |post_methods_note| replace:: If you implement custom logic that implies that you will **not** be using :class:`~telegram.ext.Application`'s methods :meth:`~telegram.ext.Application.run_polling` or :meth:`~telegram.ext.Application.run_webhook` to run your application (like it's done in `Custom Webhook Bot Example `__), the callback you set in this method **will not be called automatically**. So instead of setting a callback with this method, you have to explicitly ``await`` the function that you want to run at this stage of your application's life (in the `example mentioned above `__, that would be in ``async with application`` context manager). +.. |post_methods_note| replace:: If you implement custom logic that implies that you will **not** be using :class:`~telegram.ext.Application`'s methods :meth:`~telegram.ext.Application.run_polling` or :meth:`~telegram.ext.Application.run_webhook` to run your application (like it's done in `Custom Webhook Bot Example `__), the callback you set in this method **will not be called automatically**. So instead of setting a callback with this method, you have to explicitly ``await`` the function that you want to run at this stage of your application's life (in the `example mentioned above `__, that would be in ``async with application`` context manager). .. |removed_thumb_note| replace:: Removed the deprecated argument and attribute ``thumb``. diff --git a/examples/README.md b/examples/README.md index 78c907eaf50..76b0d9b25be 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,5 +1,5 @@ # Examples -A description of the examples in this directory can be found in the [documentation](https://docs.python-telegram-bot.org/examples.html). +A description of the examples in this directory can be found in the [documentation](https://docs.python-telegram-bot.org/examples/index.html). -All examples are licensed under the [CC0 License](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/LICENSE.txt) and are therefore fully dedicated to the public domain. You can use them as the base for your own bots without worrying about copyrights. \ No newline at end of file +All examples are licensed under the [CC0 License](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/LICENSE.txt) and are therefore fully dedicated to the public domain. You can use them as the base for your own bots without worrying about copyrights. diff --git a/src/telegram/_bot.py b/src/telegram/_bot.py index fe325d4b87a..4402508d08f 100644 --- a/src/telegram/_bot.py +++ b/src/telegram/_bot.py @@ -210,7 +210,7 @@ class Bot(TelegramObject, contextlib.AbstractAsyncContextManager["Bot"]): :exc:`TypeError`. Examples: - :any:`Raw API Bot ` + :doc:`Raw API Bot ` .. seealso:: :wiki:`Your First Bot `, :wiki:`Builder Pattern ` @@ -4835,7 +4835,7 @@ async def set_webhook( :meth:`telegram.ext.Updater.start_webhook` Examples: - :any:`Custom Webhook Bot ` + :doc:`Custom Webhook Bot ` Args: url (:obj:`str`): HTTPS url to send updates to. Use an empty string to remove webhook diff --git a/src/telegram/_chatmember.py b/src/telegram/_chatmember.py index 52e12d8fc3e..596b054f4ff 100644 --- a/src/telegram/_chatmember.py +++ b/src/telegram/_chatmember.py @@ -48,7 +48,7 @@ class ChatMember(TelegramObject): considered equal, if their :attr:`user` and :attr:`status` are equal. Examples: - :any:`Chat Member Bot ` + :doc:`Chat Member Bot ` .. versionchanged:: 20.0 diff --git a/src/telegram/_chatmemberupdated.py b/src/telegram/_chatmemberupdated.py index 2434376d459..9272ee7dc1d 100644 --- a/src/telegram/_chatmemberupdated.py +++ b/src/telegram/_chatmemberupdated.py @@ -47,7 +47,7 @@ class ChatMemberUpdated(TelegramObject): In Python :keyword:`from` is a reserved word. Use :paramref:`from_user` instead. Examples: - :any:`Chat Member Bot ` + :doc:`Chat Member Bot ` Args: chat (:class:`telegram.Chat`): Chat the user belongs to. diff --git a/src/telegram/_inline/inlinekeyboardbutton.py b/src/telegram/_inline/inlinekeyboardbutton.py index 7915ac0aa8e..87fcf4333e3 100644 --- a/src/telegram/_inline/inlinekeyboardbutton.py +++ b/src/telegram/_inline/inlinekeyboardbutton.py @@ -70,8 +70,8 @@ class InlineKeyboardButton(TelegramObject): * After Bot API 6.1, only ``HTTPS`` links will be allowed in :paramref:`login_url`. Examples: - * :any:`Inline Keyboard 1 ` - * :any:`Inline Keyboard 2 ` + * :doc:`Inline Keyboard 1 ` + * :doc:`Inline Keyboard 2 ` .. seealso:: :class:`telegram.InlineKeyboardMarkup` diff --git a/src/telegram/_inline/inlinekeyboardmarkup.py b/src/telegram/_inline/inlinekeyboardmarkup.py index 37040bc9ec5..6da1c068848 100644 --- a/src/telegram/_inline/inlinekeyboardmarkup.py +++ b/src/telegram/_inline/inlinekeyboardmarkup.py @@ -47,8 +47,8 @@ class InlineKeyboardMarkup(TelegramObject): Another kind of keyboard would be the :class:`telegram.ReplyKeyboardMarkup`. Examples: - * :any:`Inline Keyboard 1 ` - * :any:`Inline Keyboard 2 ` + * :doc:`Inline Keyboard 1 ` + * :doc:`Inline Keyboard 2 ` Args: inline_keyboard (Sequence[Sequence[:class:`telegram.InlineKeyboardButton`]]): Sequence of diff --git a/src/telegram/_inline/inlinequeryresult.py b/src/telegram/_inline/inlinequeryresult.py index 7e708ebbfe2..2a53a2d0255 100644 --- a/src/telegram/_inline/inlinequeryresult.py +++ b/src/telegram/_inline/inlinequeryresult.py @@ -38,7 +38,7 @@ class InlineQueryResult(TelegramObject): be assumed to be *public*. Examples: - :any:`Inline Bot ` + :doc:`Inline Bot ` Args: type (:obj:`str`): Type of the result. diff --git a/src/telegram/_inline/inlinequeryresultarticle.py b/src/telegram/_inline/inlinequeryresultarticle.py index cca861b76f7..cae59dd4417 100644 --- a/src/telegram/_inline/inlinequeryresultarticle.py +++ b/src/telegram/_inline/inlinequeryresultarticle.py @@ -33,7 +33,7 @@ class InlineQueryResultArticle(InlineQueryResult): """This object represents a Telegram InlineQueryResultArticle. Examples: - :any:`Inline Bot ` + :doc:`Inline Bot ` .. versionchanged:: 20.5 Removed the deprecated arguments and attributes ``thumb_*``. diff --git a/src/telegram/_inline/inputtextmessagecontent.py b/src/telegram/_inline/inputtextmessagecontent.py index 6edde810673..661c2adefe9 100644 --- a/src/telegram/_inline/inputtextmessagecontent.py +++ b/src/telegram/_inline/inputtextmessagecontent.py @@ -39,7 +39,7 @@ class InputTextMessageContent(InputMessageContent): considered equal, if their :attr:`message_text` is equal. Examples: - :any:`Inline Bot ` + :doc:`Inline Bot ` Args: message_text (:obj:`str`): Text of the message to be sent, diff --git a/src/telegram/_keyboardbuttonpolltype.py b/src/telegram/_keyboardbuttonpolltype.py index 86baadb8fa4..a4b50fe669e 100644 --- a/src/telegram/_keyboardbuttonpolltype.py +++ b/src/telegram/_keyboardbuttonpolltype.py @@ -32,7 +32,7 @@ class KeyboardButtonPollType(TelegramObject): considered equal, if their :attr:`type` is equal. Examples: - :any:`Poll Bot ` + :doc:`Poll Bot ` Args: type (:obj:`str`, optional): If :tg-const:`telegram.Poll.QUIZ` is passed, the user will be diff --git a/src/telegram/_message.py b/src/telegram/_message.py index 0eab6e314f9..5d2506012cd 100644 --- a/src/telegram/_message.py +++ b/src/telegram/_message.py @@ -927,7 +927,7 @@ class Message(MaybeInaccessibleMessage): passport_data (:class:`telegram.PassportData`): Optional. Telegram Passport data. Examples: - :any:`Passport Bot ` + :doc:`Passport Bot ` poll (:class:`telegram.Poll`): Optional. Message is a native poll, information about the poll. dice (:class:`telegram.Dice`): Optional. Message is a dice with random value. diff --git a/src/telegram/_payment/labeledprice.py b/src/telegram/_payment/labeledprice.py index a9526d4f069..ead5acf39e7 100644 --- a/src/telegram/_payment/labeledprice.py +++ b/src/telegram/_payment/labeledprice.py @@ -29,7 +29,7 @@ class LabeledPrice(TelegramObject): considered equal, if their :attr:`label` and :attr:`amount` are equal. Examples: - :any:`Payment Bot ` + :doc:`Payment Bot ` Args: label (:obj:`str`): Portion label. diff --git a/src/telegram/_payment/shippingoption.py b/src/telegram/_payment/shippingoption.py index 0b0a987a013..2b1e0c0e78a 100644 --- a/src/telegram/_payment/shippingoption.py +++ b/src/telegram/_payment/shippingoption.py @@ -36,7 +36,7 @@ class ShippingOption(TelegramObject): considered equal, if their :attr:`id` is equal. Examples: - :any:`Payment Bot ` + :doc:`Payment Bot ` Args: id (:obj:`str`): Shipping option identifier. diff --git a/src/telegram/_poll.py b/src/telegram/_poll.py index 17541bff388..0d026c632dc 100644 --- a/src/telegram/_poll.py +++ b/src/telegram/_poll.py @@ -755,7 +755,7 @@ class Poll(TelegramObject): considered equal, if their :attr:`id` is equal. Examples: - :any:`Poll Bot ` + :doc:`Poll Bot ` Args: id (:obj:`str`): Unique poll identifier. diff --git a/src/telegram/_replykeyboardmarkup.py b/src/telegram/_replykeyboardmarkup.py index 99ac0de3b00..44ec79f4c88 100644 --- a/src/telegram/_replykeyboardmarkup.py +++ b/src/telegram/_replykeyboardmarkup.py @@ -48,8 +48,8 @@ class ReplyKeyboardMarkup(TelegramObject): * Example usage: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard. - * :any:`Conversation Bot ` - * :any:`Conversation Bot 2 ` + * :doc:`Conversation Bot ` + * :doc:`Conversation Bot 2 ` Args: keyboard (Sequence[Sequence[:obj:`str` | :class:`telegram.KeyboardButton`]]): Array of diff --git a/src/telegram/_replykeyboardremove.py b/src/telegram/_replykeyboardremove.py index 05a5839595a..e39b66d0921 100644 --- a/src/telegram/_replykeyboardremove.py +++ b/src/telegram/_replykeyboardremove.py @@ -38,8 +38,8 @@ class ReplyKeyboardRemove(TelegramObject): * Example usage: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet. - * :any:`Conversation Bot ` - * :any:`Conversation Bot 2 ` + * :doc:`Conversation Bot ` + * :doc:`Conversation Bot 2 ` Args: selective (:obj:`bool`, optional): Use this parameter if you want to remove the keyboard diff --git a/src/telegram/_update.py b/src/telegram/_update.py index 1af292cce8d..b52341cc67c 100644 --- a/src/telegram/_update.py +++ b/src/telegram/_update.py @@ -198,7 +198,7 @@ class Update(TelegramObject): callback_query (:class:`telegram.CallbackQuery`): Optional. New incoming callback query. Examples: - :any:`Arbitrary Callback Data Bot ` + :doc:`Arbitrary Callback Data Bot ` shipping_query (:class:`telegram.ShippingQuery`): Optional. New incoming shipping query. Only for invoices with flexible price. pre_checkout_query (:class:`telegram.PreCheckoutQuery`): Optional. New incoming diff --git a/src/telegram/_webappdata.py b/src/telegram/_webappdata.py index 04583cf99f5..0bd5e7de098 100644 --- a/src/telegram/_webappdata.py +++ b/src/telegram/_webappdata.py @@ -29,7 +29,7 @@ class WebAppData(TelegramObject): considered equal, if their :attr:`data` and :attr:`button_text` are equal. Examples: - :any:`Webapp Bot ` + :doc:`Webapp Bot ` .. versionadded:: 20.0 diff --git a/src/telegram/_webappinfo.py b/src/telegram/_webappinfo.py index 2d29cef7df5..526df7ab391 100644 --- a/src/telegram/_webappinfo.py +++ b/src/telegram/_webappinfo.py @@ -30,7 +30,7 @@ class WebAppInfo(TelegramObject): considered equal, if their :attr:`url` are equal. Examples: - :any:`Webapp Bot ` + :doc:`Webapp Bot ` .. versionadded:: 20.0 diff --git a/src/telegram/error.py b/src/telegram/error.py index 014bf8631b3..95030d656b6 100644 --- a/src/telegram/error.py +++ b/src/telegram/error.py @@ -101,7 +101,7 @@ class Forbidden(TelegramError): """Raised when the bot has not enough rights to perform the requested action. Examples: - :any:`Raw API Bot ` + :doc:`Raw API Bot ` .. versionchanged:: 20.0 This class was previously named ``Unauthorized``. @@ -146,7 +146,7 @@ class NetworkError(TelegramError): `attribute `_. Examples: - :any:`Raw API Bot ` + :doc:`Raw API Bot ` .. seealso:: :wiki:`Handling network errors ` diff --git a/src/telegram/ext/_application.py b/src/telegram/ext/_application.py index d4a216e6b27..257e9c9c48f 100644 --- a/src/telegram/ext/_application.py +++ b/src/telegram/ext/_application.py @@ -158,7 +158,7 @@ class Application( of that or :obj:`None`. Examples: - :any:`Echo Bot ` + :doc:`Echo Bot ` .. seealso:: :wiki:`Your First Bot `, :wiki:`Architecture Overview ` @@ -1804,7 +1804,7 @@ def add_error_handler( Attempts to add the same callback multiple times will be ignored. Examples: - :any:`Errorhandler Bot ` + :doc:`Errorhandler Bot ` Hint: This method currently has no influence on calls to :meth:`process_error` that are diff --git a/src/telegram/ext/_applicationbuilder.py b/src/telegram/ext/_applicationbuilder.py index 97e55089502..9d9a8ef5077 100644 --- a/src/telegram/ext/_applicationbuilder.py +++ b/src/telegram/ext/_applicationbuilder.py @@ -900,7 +900,7 @@ def private_key( for :attr:`telegram.ext.Application.bot`. Examples: - :any:`Passport Bot ` + :doc:`Passport Bot ` .. seealso:: :wiki:`Telegram Passports ` @@ -962,7 +962,7 @@ def arbitrary_callback_data( pip install "python-telegram-bot[callback-data]" Examples: - :any:`Arbitrary callback_data Bot ` + :doc:`Arbitrary callback_data Bot ` .. seealso:: :wiki:`Arbitrary callback_data ` @@ -1093,7 +1093,7 @@ def job_queue( instantiated if the requirements of :class:`telegram.ext.JobQueue` are installed. Examples: - :any:`Timer Bot ` + :doc:`Timer Bot ` .. seealso:: :wiki:`Job Queue ` @@ -1133,7 +1133,7 @@ def persistence( to the persistence in order to avoid race conditions. Examples: - :any:`Persistent Conversation Bot ` + :doc:`Persistent Conversation Bot ` .. seealso:: :wiki:`Making Your Bot Persistent ` @@ -1158,7 +1158,7 @@ def context_types( :attr:`telegram.ext.Application.context_types`. Examples: - :any:`Context Types Bot ` + :doc:`Context Types Bot ` Args: context_types (:class:`telegram.ext.ContextTypes`): The context types. diff --git a/src/telegram/ext/_callbackcontext.py b/src/telegram/ext/_callbackcontext.py index 2689729c15c..beaa8b8917d 100644 --- a/src/telegram/ext/_callbackcontext.py +++ b/src/telegram/ext/_callbackcontext.py @@ -73,8 +73,8 @@ class CallbackContext(Generic[BT, UD, CD, BD]): 4. The type of :attr:`bot_data` (if :attr:`bot_data` is not :obj:`None`). Examples: - * :any:`Context Types Bot ` - * :any:`Custom Webhook Bot ` + * :doc:`Context Types Bot ` + * :doc:`Custom Webhook Bot ` .. seealso:: :attr:`telegram.ext.ContextTypes.DEFAULT_TYPE`, :wiki:`Job Queue ` diff --git a/src/telegram/ext/_callbackdatacache.py b/src/telegram/ext/_callbackdatacache.py index 4fd73b4ad44..7c252a5cf32 100644 --- a/src/telegram/ext/_callbackdatacache.py +++ b/src/telegram/ext/_callbackdatacache.py @@ -49,7 +49,7 @@ class InvalidCallbackData(TelegramError): Raised when the received callback data has been tampered with or deleted from cache. Examples: - :any:`Arbitrary Callback Data Bot ` + :doc:`Arbitrary Callback Data Bot ` .. seealso:: :wiki:`Arbitrary callback_data ` @@ -127,7 +127,7 @@ class CallbackDataCache: pip install "python-telegram-bot[callback-data]" Examples: - :any:`Arbitrary Callback Data Bot ` + :doc:`Arbitrary Callback Data Bot ` .. seealso:: :wiki:`Architecture Overview `, :wiki:`Arbitrary callback_data ` diff --git a/src/telegram/ext/_contexttypes.py b/src/telegram/ext/_contexttypes.py index bd975b6bdda..68e8ac7d130 100644 --- a/src/telegram/ext/_contexttypes.py +++ b/src/telegram/ext/_contexttypes.py @@ -33,7 +33,7 @@ class ContextTypes(Generic[CCT, UD, CD, BD]): interface. Examples: - :any:`ContextTypes Bot ` + :doc:`ContextTypes Bot ` .. seealso:: :wiki:`Architecture Overview `, :wiki:`Storing Bot, User and Chat Related Data ` diff --git a/src/telegram/ext/_extbot.py b/src/telegram/ext/_extbot.py index 6e54f3a7574..972480b7f07 100644 --- a/src/telegram/ext/_extbot.py +++ b/src/telegram/ext/_extbot.py @@ -166,7 +166,7 @@ class ExtBot(Bot, Generic[RLARGS]): additional argument, as this method will never be rate limited. Examples: - :any:`Arbitrary Callback Data Bot ` + :doc:`Arbitrary Callback Data Bot ` .. seealso:: :wiki:`Arbitrary callback_data ` @@ -303,7 +303,7 @@ def callback_data_cache(self) -> CallbackDataCache | None: objects passed as callback data for :class:`telegram.InlineKeyboardButton`. Examples: - :any:`Arbitrary Callback Data Bot ` + :doc:`Arbitrary Callback Data Bot ` .. versionchanged:: 20.0 * This property is now read-only. diff --git a/src/telegram/ext/_handlers/chatmemberhandler.py b/src/telegram/ext/_handlers/chatmemberhandler.py index cfdeae714ea..b4e74bd45da 100644 --- a/src/telegram/ext/_handlers/chatmemberhandler.py +++ b/src/telegram/ext/_handlers/chatmemberhandler.py @@ -38,7 +38,7 @@ class ChatMemberHandler(BaseHandler[Update, CCT, RT]): attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. Examples: - :any:`Chat Member Bot ` + :doc:`Chat Member Bot ` .. versionadded:: 13.4 diff --git a/src/telegram/ext/_handlers/commandhandler.py b/src/telegram/ext/_handlers/commandhandler.py index 8056a5acb77..459e4df3462 100644 --- a/src/telegram/ext/_handlers/commandhandler.py +++ b/src/telegram/ext/_handlers/commandhandler.py @@ -65,8 +65,8 @@ class CommandHandler(BaseHandler[Update, CCT, RT]): attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. Examples: - * :any:`Timer Bot ` - * :any:`Error Handler Bot ` + * :doc:`Timer Bot ` + * :doc:`Error Handler Bot ` .. versionchanged:: 20.0 diff --git a/src/telegram/ext/_handlers/conversationhandler.py b/src/telegram/ext/_handlers/conversationhandler.py index 044e957aa41..9474dcab549 100644 --- a/src/telegram/ext/_handlers/conversationhandler.py +++ b/src/telegram/ext/_handlers/conversationhandler.py @@ -171,13 +171,13 @@ class ConversationHandler(BaseHandler[Update, CCT, object]): states to continue the parent conversation after the child conversation has ended or even map a state to :attr:`END` to end the *parent* conversation from within the child conversation. For an example on nested :class:`ConversationHandler` s, see - :any:`examples.nestedconversationbot`. + :doc:`/examples/nestedconversationbot`. Examples: - * :any:`Conversation Bot ` - * :any:`Conversation Bot 2 ` - * :any:`Nested Conversation Bot ` - * :any:`Persistent Conversation Bot ` + * :doc:`Conversation Bot ` + * :doc:`Conversation Bot 2 ` + * :doc:`Nested Conversation Bot ` + * :doc:`Persistent Conversation Bot ` Args: entry_points (list[:class:`telegram.ext.BaseHandler`]): A list of :obj:`BaseHandler` diff --git a/src/telegram/ext/_handlers/inlinequeryhandler.py b/src/telegram/ext/_handlers/inlinequeryhandler.py index de04b25b431..d5b37a0a247 100644 --- a/src/telegram/ext/_handlers/inlinequeryhandler.py +++ b/src/telegram/ext/_handlers/inlinequeryhandler.py @@ -49,7 +49,7 @@ class InlineQueryHandler(BaseHandler[Update, CCT, RT]): updates won't be handled, if :attr:`chat_types` is passed. Examples: - :any:`Inline Bot ` + :doc:`Inline Bot ` Args: diff --git a/src/telegram/ext/_handlers/pollanswerhandler.py b/src/telegram/ext/_handlers/pollanswerhandler.py index 5564b588d40..408ac70de9a 100644 --- a/src/telegram/ext/_handlers/pollanswerhandler.py +++ b/src/telegram/ext/_handlers/pollanswerhandler.py @@ -32,7 +32,7 @@ class PollAnswerHandler(BaseHandler[Update, CCT, RT]): attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. Examples: - :any:`Poll Bot ` + :doc:`Poll Bot ` Args: callback (:term:`coroutine function`): The callback function for this handler. Will be diff --git a/src/telegram/ext/_handlers/pollhandler.py b/src/telegram/ext/_handlers/pollhandler.py index a029bb559d1..d890a674a47 100644 --- a/src/telegram/ext/_handlers/pollhandler.py +++ b/src/telegram/ext/_handlers/pollhandler.py @@ -32,7 +32,7 @@ class PollHandler(BaseHandler[Update, CCT, RT]): attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. Examples: - :any:`Poll Bot ` + :doc:`Poll Bot ` Args: callback (:term:`coroutine function`): The callback function for this handler. Will be diff --git a/src/telegram/ext/_handlers/precheckoutqueryhandler.py b/src/telegram/ext/_handlers/precheckoutqueryhandler.py index 5fb1dab2680..8619b53eb9d 100644 --- a/src/telegram/ext/_handlers/precheckoutqueryhandler.py +++ b/src/telegram/ext/_handlers/precheckoutqueryhandler.py @@ -39,7 +39,7 @@ class PreCheckoutQueryHandler(BaseHandler[Update, CCT, RT]): attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. Examples: - :any:`Payment Bot ` + :doc:`Payment Bot ` Args: callback (:term:`coroutine function`): The callback function for this handler. Will be diff --git a/src/telegram/ext/_handlers/shippingqueryhandler.py b/src/telegram/ext/_handlers/shippingqueryhandler.py index c46fad19210..92a8f482d8a 100644 --- a/src/telegram/ext/_handlers/shippingqueryhandler.py +++ b/src/telegram/ext/_handlers/shippingqueryhandler.py @@ -31,7 +31,7 @@ class ShippingQueryHandler(BaseHandler[Update, CCT, RT]): attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. Examples: - :any:`Payment Bot ` + :doc:`Payment Bot ` Args: callback (:term:`coroutine function`): The callback function for this handler. Will be diff --git a/src/telegram/ext/_jobqueue.py b/src/telegram/ext/_jobqueue.py index 7ad54530913..1455c27a544 100644 --- a/src/telegram/ext/_jobqueue.py +++ b/src/telegram/ext/_jobqueue.py @@ -81,7 +81,7 @@ class JobQueue(Generic[CCT]): pip install "python-telegram-bot[job-queue]" Examples: - :any:`Timer Bot ` + :doc:`Timer Bot ` .. seealso:: :wiki:`Architecture Overview `, :wiki:`Job Queue ` diff --git a/src/telegram/ext/_picklepersistence.py b/src/telegram/ext/_picklepersistence.py index f97a0ab0fbc..c6b9ce2c33c 100644 --- a/src/telegram/ext/_picklepersistence.py +++ b/src/telegram/ext/_picklepersistence.py @@ -134,7 +134,7 @@ class PicklePersistence(BasePersistence[UD, CD, BD]): :attr:`~BasePersistence.bot` will be inserted back when loading the data. Examples: - :any:`Persistent Conversation Bot ` + :doc:`Persistent Conversation Bot ` .. seealso:: :wiki:`Making Your Bot Persistent ` diff --git a/src/telegram/helpers.py b/src/telegram/helpers.py index 1c30a303afc..e5cdf33562f 100644 --- a/src/telegram/helpers.py +++ b/src/telegram/helpers.py @@ -163,7 +163,7 @@ def create_deep_linked_url( Examples: * ``create_deep_linked_url(bot.get_me().username, "some-params")`` - * :any:`Deep Linking ` + * :doc:`Deep Linking ` Args: bot_username (:obj:`str`): The username to link to. From 84a463d75eec751f93e464ac0973cceaaab29b6c Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Tue, 4 Aug 2026 04:24:04 -0400 Subject: [PATCH 4/4] Remove invalid AI change --- .github/CONTRIBUTING.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index cb140409134..cd6871452a2 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -169,7 +169,7 @@ Feel free to copy (parts of) the checklist to the PR description to remind you o - [ ] Created new or adapted existing unit tests - [ ] Documented code changes according to the [CSI standard](https://standards.mousepawmedia.com/en/stable/csi.html) - [ ] Added myself alphabetically to `AUTHORS.rst` (optional) - - [ ] Added new public classes to all suitable ``__all__`` s (their API pages are generated automatically) and new modules to the docs + - [ ] Added new classes & modules to the docs and all suitable ``__all__`` s - [ ] Checked the [Stability Policy](https://docs.python-telegram-bot.org/stability_policy.html) in case of deprecations or changes to documented behavior **If the PR contains API changes (otherwise, you can ignore this passage)** @@ -232,7 +232,6 @@ or, if you don't have ``make`` available (e.g. on Windows): Once the process terminates, you can view the built documentation by opening ``docs/build/html/index.html`` with a browser. - Add ``.. versionadded:: NEXT.VERSION``, ``.. versionchanged:: NEXT.VERSION`` or ``.. deprecated:: NEXT.VERSION`` to the associated documentation of your changes, depending on what kind of change you made. This only applies if the change you made is visible to an end user. The directives should be added to class/method descriptions if their general behaviour changed and to the description of all arguments & attributes that changed. - For a new class, put ``.. versionadded:: NEXT.VERSION`` in the class docstring. Dev facing documentation ------------------------