Co-authored-by: poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: Harshil <ilovebhagwan@gmail.com>
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
This commit is contained in:
Bibo-Joshi 2021-04-30 10:47:41 +02:00 committed by GitHub
parent b20265819b
commit bae57c7f8f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
174 changed files with 4125 additions and 305 deletions

View file

@ -1,3 +1,6 @@
sphinx==3.5.2
sphinx_rtd_theme==0.5.1
sphinx==3.5.4
sphinx-pypi-upload
# When bumping this, make sure to rebuild the dark-mode CSS
# More instructions at source/_static/dark.css
# Ofc once https://github.com/readthedocs/sphinx_rtd_theme/issues/224 is closed, we should use that
sphinx_rtd_theme==0.5.2

3461
docs/source/_static/dark.css Normal file

File diff suppressed because it is too large Load diff

View file

@ -51,7 +51,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'Python Telegram Bot'
project = u'python-telegram-bot'
copyright = u'2015-2021, Leandro Toledo'
author = u'Leandro Toledo'
@ -118,7 +118,9 @@ html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
html_theme_options = {
'style_external_links': True,
}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
@ -205,7 +207,7 @@ html_static_path = ['_static']
#html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'PythonTelegramBotdoc'
htmlhelp_basename = 'python-telegram-bot-doc'
# -- Options for LaTeX output ---------------------------------------------
@ -230,7 +232,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'PythonTelegramBot.tex', u'Python Telegram Bot Documentation',
(master_doc, 'python-telegram-bot.tex', u'python-telegram-bot Documentation',
author, 'manual'),
]
@ -260,7 +262,7 @@ latex_logo = 'ptb-logo_1024.png'
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'pythontelegrambot', u'Python Telegram Bot Documentation',
(master_doc, 'python-telegram-bot', u'python-telegram-bot Documentation',
[author], 1)
]
@ -274,8 +276,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'PythonTelegramBot', u'Python Telegram Bot Documentation',
author, 'PythonTelegramBot', "We have made you a wrapper you can't refuse",
(master_doc, 'python-telegram-bot', u'python-telegram-bot Documentation',
author, 'python-telegram-bot', "We have made you a wrapper you can't refuse",
'Miscellaneous'),
]
@ -303,4 +305,5 @@ def autodoc_skip_member(app, what, name, obj, skip, options):
def setup(app):
app.add_css_file("dark.css")
app.connect('autodoc-skip-member', autodoc_skip_member)

View file

@ -15,14 +15,17 @@ On our wiki you will also find guides like how to use handlers, webhooks, emoji,
Examples
========
A great way to learn is by looking at examples. Ours can be found at our `github in the examples folder <https://github.com/python-telegram-bot/python-telegram-bot/tree/master/examples>`_.
A great way to learn is by looking at examples. Ours can be found in our `examples folder on Github <https://github.com/python-telegram-bot/python-telegram-bot/tree/master/examples>`_.
Reference
=========
Below you can find a reference of all the classes and methods in python-telegram-bot.
Apart from the `telegram.ext` package the objects should reflect the types defined in the `official telegram bot api documentation <https://core.telegram.org/bots/api>`_.
Apart from the `telegram.ext` package the objects should reflect the types defined in the `official Telegram Bot API documentation <https://core.telegram.org/bots/api>`_.
.. toctree::
telegram.ext
.. toctree::
telegram

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/animation.py
telegram.Animation
==================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/audio.py
telegram.Audio
==============

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/bot.py
telegram.Bot
============

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommand.py
telegram.BotCommand
===================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/games/callbackgame.py
telegram.Callbackgame
=====================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackquery.py
telegram.CallbackQuery
======================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chat.py
telegram.Chat
=============

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chataction.py
telegram.ChatAction
===================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatinvitelink.py
telegram.ChatInviteLink
=======================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatlocation.py
telegram.ChatLocation
=====================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py
telegram.ChatMember
===================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmemberupdated.py
telegram.ChatMemberUpdated
==========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatpermissions.py
telegram.ChatPermissions
========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/chatphoto.py
telegram.ChatPhoto
==================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/choseninlineresult.py
telegram.ChosenInlineResult
===========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/constants.py
telegram.constants Module
=========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/contact.py
telegram.Contact
================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py
telegram.Credentials
====================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py
telegram.DataCredentials
========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/dice.py
telegram.Dice
=============

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/document.py
telegram.Document
=================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py
telegram.EncryptedCredentials
=============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/encryptedpassportelement.py
telegram.EncryptedPassportElement
=================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/error.py
telegram.error module
=====================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/basepersistence.py
telegram.ext.BasePersistence
============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackcontext.py
telegram.ext.CallbackContext
============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackqueryhandler.py
telegram.ext.CallbackQueryHandler
=================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/chatmemberhandler.py
telegram.ext.ChatMemberHandler
==============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/choseninlineresulthandler.py
telegram.ext.ChosenInlineResultHandler
======================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/commandhandler.py
telegram.ext.CommandHandler
===========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/conversationhandler.py
telegram.ext.ConversationHandler
================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/defaults.py
telegram.ext.Defaults
=====================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/messagequeue.py
telegram.ext.DelayQueue
=======================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/dictpersistence.py
telegram.ext.DictPersistence
============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/dispatcher.py
telegram.ext.Dispatcher
=======================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/dispatcher.py
telegram.ext.DispatcherHandlerStop
==================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/filters.py
telegram.ext.filters Module
===========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/handler.py
telegram.ext.Handler
====================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/inlinequeryhandler.py
telegram.ext.InlineQueryHandler
===============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/jobqueue.py
telegram.ext.Job
=====================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/jobqueue.py
telegram.ext.JobQueue
=====================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/messagehandler.py
telegram.ext.MessageHandler
===========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/messagequeue.py
telegram.ext.MessageQueue
=========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/picklepersistence.py
telegram.ext.PicklePersistence
==============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/pollanswerhandler.py
telegram.ext.PollAnswerHandler
==============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/pollhandler.py
telegram.ext.PollHandler
========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/precheckoutqueryhandler.py
telegram.ext.PreCheckoutQueryHandler
====================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/commandhandler.py
telegram.ext.PrefixHandler
===========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/regexhandler.py
telegram.ext.RegexHandler
=========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/shippingqueryhandler.py
telegram.ext.ShippingQueryHandler
=================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/stringcommandhandler.py
telegram.ext.StringCommandHandler
=================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/stringregexhandler.py
telegram.ext.StringRegexHandler
===============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/typehandler.py
telegram.ext.TypeHandler
========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/updater.py
telegram.ext.Updater
====================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/utils/promise.py
telegram.ext.utils.promise.Promise
==================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/file.py
telegram.File
=============

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py
telegram.FileCredentials
========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/forcereply.py
telegram.ForceReply
===================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/games/game.py
telegram.Game
=============

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/games/gamehighscore.py
telegram.GameHighScore
======================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/data.py
telegram.IdDocumentData
=======================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinekeyboardbutton.py
telegram.InlineKeyboardButton
=============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinekeyboardmarkup.py
telegram.InlineKeyboardMarkup
=============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequery.py
telegram.InlineQuery
====================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresult.py
telegram.InlineQueryResult
==========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultarticle.py
telegram.InlineQueryResultArticle
=================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultaudio.py
telegram.InlineQueryResultAudio
===============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedaudio.py
telegram.InlineQueryResultCachedAudio
=====================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcacheddocument.py
telegram.InlineQueryResultCachedDocument
========================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedgif.py
telegram.InlineQueryResultCachedGif
===================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedmpeg4gif.py
telegram.InlineQueryResultCachedMpeg4Gif
========================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedphoto.py
telegram.InlineQueryResultCachedPhoto
=====================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedsticker.py
telegram.InlineQueryResultCachedSticker
=======================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedvideo.py
telegram.InlineQueryResultCachedVideo
=====================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedvoice.py
telegram.InlineQueryResultCachedVoice
=====================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcontact.py
telegram.InlineQueryResultContact
=================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultdocument.py
telegram.InlineQueryResultDocument
==================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultgame.py
telegram.InlineQueryResultGame
==============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultgif.py
telegram.InlineQueryResultGif
=============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultlocation.py
telegram.InlineQueryResultLocation
==================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultmpeg4gif.py
telegram.InlineQueryResultMpeg4Gif
==================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultphoto.py
telegram.InlineQueryResultPhoto
===============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultvenue.py
telegram.InlineQueryResultVenue
===============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultvideo.py
telegram.InlineQueryResultVideo
===============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultvoice.py
telegram.InlineQueryResultVoice
===============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputcontactmessagecontent.py
telegram.InputContactMessageContent
===================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputfile.py
telegram.InputFile
==================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputlocationmessagecontent.py
telegram.InputLocationMessageContent
====================================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py
telegram.InputMedia
===================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py
telegram.InputMediaAnimation
============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py
telegram.InputMediaAudio
========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py
telegram.InputMediaDocument
===========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py
telegram.InputMediaPhoto
========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py
telegram.InputMediaVideo
========================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputmessagecontent.py
telegram.InputMessageContent
============================

View file

@ -1,3 +1,5 @@
:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputtextmessagecontent.py
telegram.InputTextMessageContent
================================

Some files were not shown because too many files have changed in this diff Show more