python-telegram-bot · tsnoam · Jul 23, 2017 · Jun 26, 2017 · Jun 26, 2017 · Jun 27, 2017
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -7,9 +7,10 @@ Changes
 - Improved filters for user_id/username/chat.
 - Internal restructure of files.
 - Improved unitests.
-- Fully support Bot API 3.2.
+- Fully support Bot API 3.2
+- Modified docstrings
 - Remove deprecated ``telegram.Emoji``.
-- Remove deprecated ``Botan`` import from ``utils``.
+- Remove deprecated ``Botan`` import from ``utils`` (``Botan`` is still available through ``contrib``).
 - Remove deprecated ``ReplyKeyboardHide``.
 - Remove deprecated ``edit_message`` argument of `bot.set_game_score``.
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,6 +6,9 @@
 Welcome to Python Telegram Bot's documentation!
 ===============================================
 
+Below you can find the documentation for the python-telegram-bot library. except for the .ext package most of the
+objects in the package reflect the types as defined by the `telegram bot api <https://core.telegram.org/bots/api>`_.
+
 .. toctree::
    telegram
 

diff --git a/docs/source/telegram.animation.rst b/docs/source/telegram.animation.rst
@@ -1,7 +1,6 @@
-telegram.animation module
-=========================
+telegram.Animation
+==================
 
-.. automodule:: telegram.animation
+.. autoclass:: telegram.Animation
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.audio.rst b/docs/source/telegram.audio.rst
@@ -1,7 +1,6 @@
-telegram.audio module
-=====================
+telegram.Audio
+==============
 
-.. automodule:: telegram.audio
+.. autoclass:: telegram.Audio
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.base.rst b/docs/source/telegram.base.rst
diff --git a/docs/source/telegram.bot.rst b/docs/source/telegram.bot.rst
@@ -1,6 +1,6 @@
-telegram.bot module
-===================
+telegram.Bot
+============
 
-.. automodule:: telegram.bot
+.. autoclass:: telegram.Bot
     :members:
-    :show-inheritance:
+    :show-inheritance:
diff --git a/docs/source/telegram.callbackgame.rst b/docs/source/telegram.callbackgame.rst
@@ -1,7 +1,6 @@
-telegram.callbackgame module
-============================
+telegram.Callbackgame
+=====================
 
-.. automodule:: telegram.callbackgame
+.. autoclass:: telegram.CallbackGame
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.callbackquery.rst b/docs/source/telegram.callbackquery.rst
@@ -1,7 +1,6 @@
-telegram.callbackquery module
-=============================
+telegram.CallbackQuery
+======================
 
-.. automodule:: telegram.callbackquery
+.. autoclass:: telegram.CallbackQuery
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.chat.rst b/docs/source/telegram.chat.rst
@@ -1,7 +1,6 @@
-telegram.chat module
-=========================
+telegram.Chat
+=============
 
-.. automodule:: telegram.chat
+.. autoclass:: telegram.Chat
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.chataction.rst b/docs/source/telegram.chataction.rst
@@ -1,7 +1,6 @@
-telegram.chataction module
-==========================
+telegram.ChatAction
+===================
 
-.. automodule:: telegram.chataction
+.. autoclass:: telegram.ChatAction
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.chatmember.rst b/docs/source/telegram.chatmember.rst
@@ -1,7 +1,6 @@
-telegram.chatmember module
-==========================
+telegram.ChatMember
+===================
 
-.. automodule:: telegram.chatmember
+.. autoclass:: telegram.ChatMember
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.chatphoto.rst b/docs/source/telegram.chatphoto.rst
@@ -0,0 +1,6 @@
+telegram.ChatPhoto
+==================
+
+.. autoclass:: telegram.ChatPhoto
+    :members:
+    :show-inheritance:
diff --git a/docs/source/telegram.choseninlineresult.rst b/docs/source/telegram.choseninlineresult.rst
@@ -1,7 +1,6 @@
-telegram.choseninlineresult module
-==================================
+telegram.ChosenInlineResult
+===========================
 
-.. automodule:: telegram.choseninlineresult
+.. autoclass:: telegram.ChosenInlineResult
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.constants.rst b/docs/source/telegram.constants.rst
@@ -1,7 +1,6 @@
-telegram.constants module
+telegram.constants Module
 =========================
 
 .. automodule:: telegram.constants
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.contact.rst b/docs/source/telegram.contact.rst
@@ -1,7 +1,6 @@
-telegram.contact module
-=======================
+telegram.Contact
+================
 
-.. automodule:: telegram.contact
+.. autoclass:: telegram.Contact
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.contrib.botan.rst b/docs/source/telegram.contrib.botan.rst
@@ -1,7 +1,7 @@
-telegram.contrib.botan module
-=============================
+telegram.contrib.Botan
+======================
 
-.. automodule:: telegram.contrib.botan
+.. autoclass:: telegram.contrib.Botan
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.contrib.rst b/docs/source/telegram.contrib.rst
@@ -15,3 +15,4 @@ Module contents
     :members:
     :undoc-members:
     :show-inheritance:
+    :noindex:
diff --git a/docs/source/telegram.document.rst b/docs/source/telegram.document.rst
@@ -1,7 +1,6 @@
-telegram.document module
-========================
+telegram.Document
+=================
 
-.. automodule:: telegram.document
+.. autoclass:: telegram.Document
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.ext.callbackqueryhandler.rst b/docs/source/telegram.ext.callbackqueryhandler.rst
@@ -1,7 +1,6 @@
-telegram.ext.callbackqueryhandler module
-========================================
+telegram.ext.CallbackQueryHandler
+=================================
 
-.. automodule:: telegram.ext.callbackqueryhandler
+.. autoclass:: telegram.ext.CallbackQueryHandler
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.ext.choseninlineresulthandler.rst b/docs/source/telegram.ext.choseninlineresulthandler.rst
@@ -1,7 +1,6 @@
-telegram.ext.choseninlineresulthandler module
-=============================================
+telegram.ext.ChosenInlineResultHandler
+======================================
 
-.. automodule:: telegram.ext.choseninlineresulthandler
+.. autoclass:: telegram.ext.ChosenInlineResultHandler
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.ext.commandhandler.rst b/docs/source/telegram.ext.commandhandler.rst
@@ -1,7 +1,6 @@
-telegram.ext.commandhandler module
-==================================
+telegram.ext.CommandHandler
+===========================
 
-.. automodule:: telegram.ext.commandhandler
+.. autoclass:: telegram.ext.CommandHandler
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.ext.conversationhandler.rst b/docs/source/telegram.ext.conversationhandler.rst
@@ -1,7 +1,6 @@
-telegram.ext.conversationhandler module
-=======================================
+telegram.ext.ConversationHandler
+================================
 
-.. automodule:: telegram.ext.conversationhandler
+.. autoclass:: telegram.ext.ConversationHandler
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.ext.delayqueue.rst b/docs/source/telegram.ext.delayqueue.rst
@@ -0,0 +1,7 @@
+telegram.ext.DelayQueue
+=======================
+
+.. autoclass:: telegram.ext.DelayQueue
+    :members:
+    :show-inheritance:
+    :special-members:
diff --git a/docs/source/telegram.ext.dispatcher.rst b/docs/source/telegram.ext.dispatcher.rst
@@ -1,7 +1,6 @@
-telegram.ext.dispatcher module
-==============================
+telegram.ext.Dispatcher
+=======================
 
-.. automodule:: telegram.ext.dispatcher
+.. autoclass:: telegram.ext.Dispatcher
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.ext.filters.rst b/docs/source/telegram.ext.filters.rst
@@ -1,7 +1,6 @@
-telegram.ext.filters module
+telegram.ext.filters Module
 ===========================
 
 .. automodule:: telegram.ext.filters
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.ext.handler.rst b/docs/source/telegram.ext.handler.rst
@@ -1,7 +1,7 @@
-telegram.ext.handler module
-===========================
+telegram.ext.Handler
+====================
 
-.. automodule:: telegram.ext.handler
+.. autoclass:: telegram.ext.Handler
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.ext.inlinequeryhandler.rst b/docs/source/telegram.ext.inlinequeryhandler.rst
@@ -1,7 +1,6 @@
-telegram.ext.inlinequeryhandler module
-======================================
+telegram.ext.InlineQueryHandler
+===============================
 
-.. automodule:: telegram.ext.inlinequeryhandler
+.. autoclass:: telegram.ext.InlineQueryHandler
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.ext.jobqueue.rst b/docs/source/telegram.ext.jobqueue.rst
@@ -1,7 +1,6 @@
-telegram.ext.jobqueue module
-============================
+telegram.ext.JobQueue
+=====================
 
-.. automodule:: telegram.ext.jobqueue
+.. autoclass:: telegram.ext.JobQueue
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.ext.messagehandler.rst b/docs/source/telegram.ext.messagehandler.rst
@@ -1,7 +1,6 @@
-telegram.ext.messagehandler module
-==================================
+telegram.ext.MessageHandler
+===========================
 
-.. automodule:: telegram.ext.messagehandler
+.. autoclass:: telegram.ext.MessageHandler
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.ext.messagequeue.rst b/docs/source/telegram.ext.messagequeue.rst
@@ -1,7 +1,7 @@
-telegram.ext.messagequeue module
-================================
+telegram.ext.MessageQueue
+=========================
 
-.. automodule:: telegram.ext.messagequeue
+.. autoclass:: telegram.ext.MessageQueue
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members:
diff --git a/docs/source/telegram.ext.precheckoutqueryhandler.rst b/docs/source/telegram.ext.precheckoutqueryhandler.rst
@@ -0,0 +1,6 @@
+telegram.ext.PreCheckoutQueryHandler
+====================================
+
+.. autoclass:: telegram.ext.PreCheckoutQueryHandler
+    :members:
+    :show-inheritance:
diff --git a/docs/source/telegram.ext.regexhandler.rst b/docs/source/telegram.ext.regexhandler.rst
@@ -1,7 +1,6 @@
-telegram.ext.regexhandler module
-================================
+telegram.ext.RegexHandler
+=========================
 
-.. automodule:: telegram.ext.regexhandler
+.. autoclass:: telegram.ext.RegexHandler
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/source/telegram.ext.rst b/docs/source/telegram.ext.rst
@@ -1,32 +1,30 @@
 telegram.ext package
 ====================
 
-Submodules
-----------
-
 .. toctree::
 
     telegram.ext.updater
     telegram.ext.dispatcher
+    telegram.ext.filters
     telegram.ext.jobqueue
+    telegram.ext.messagequeue
+    telegram.ext.delayqueue
+
+Handlers
+--------
+
+.. toctree::
+
     telegram.ext.handler
     telegram.ext.callbackqueryhandler
     telegram.ext.choseninlineresulthandler
     telegram.ext.conversationhandler
     telegram.ext.commandhandler
     telegram.ext.inlinequeryhandler
     telegram.ext.messagehandler
-    telegram.ext.messagequeue
-    telegram.ext.filters
+    telegram.ext.precheckoutqueryhandler
     telegram.ext.regexhandler
+    telegram.ext.shippingqueryhandler
     telegram.ext.stringcommandhandler
     telegram.ext.stringregexhandler
     telegram.ext.typehandler
-
-Module contents
----------------
-
-.. automodule:: telegram.ext
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/docs/source/telegram.ext.shippingqueryhandler.rst b/docs/source/telegram.ext.shippingqueryhandler.rst
@@ -0,0 +1,6 @@
+telegram.ext.ShippingQueryHandler
+=================================
+
+.. autoclass:: telegram.ext.ShippingQueryHandler
+    :members:
+    :show-inheritance:
diff --git a/docs/source/telegram.ext.stringcommandhandler.rst b/docs/source/telegram.ext.stringcommandhandler.rst
@@ -1,7 +1,6 @@
-telegram.ext.stringcommandhandler module
-========================================
+telegram.ext.StringCommandHandler
+=================================
 
-.. automodule:: telegram.ext.stringcommandhandler
+.. autoclass:: telegram.ext.StringCommandHandler
     :members:
-    :undoc-members:
     :show-inheritance: