Adding new modules to docs #232

docs/source/telegram.ext.jobqueue.rst

@@ -1,7 +1,7 @@
-telegram.jobqueue module
+telegram.ext.jobqueue module
 ========================
 
-.. automodule:: telegram.jobqueue
+.. automodule:: telegram.ext.jobqueue
     :members:
     :undoc-members:
     :show-inheritance:

docs/source/telegram.inlinekeyboardbutton.rst

@@ -0,0 +1,7 @@
+telegram.inlinekeyboardbutton module
+===========================
+
+.. automodule:: telegram.inlinekeyboardbutton
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinekeyboardmarkup.rst

@@ -0,0 +1,7 @@
+telegram.inlinekeyboardmarkup module
+==========================
+
+.. automodule:: telegram.inlinekeyboardmarkup
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultarticle.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultarticle module
+=================================
+
+.. automodule:: telegram.inlinequeryresultarticle
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultaudio.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultaudio module
+=================================
+
+.. automodule:: telegram.inlinequeryresultaudio
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcachedaudio.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultcachedaudio module
+=================================
+
+.. automodule:: telegram.inlinequeryresultcachedaudio
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcacheddocument.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultcacheddocument module
+=================================
+
+.. automodule:: telegram.inlinequeryresultcacheddocument
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcachedgif.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultcachedgif module
+=================================
+
+.. automodule:: telegram.inlinequeryresultcachedgif
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultcachedmpeg4gif module
+=================================
+
+.. automodule:: telegram.inlinequeryresultcachedmpeg4gif
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcachedphoto.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultcachedphoto module
+=================================
+
+.. automodule:: telegram.inlinequeryresultcachedphoto
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcachedsticker.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultcachedsticker module
+=================================
+
+.. automodule:: telegram.inlinequeryresultcachedsticker
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcachedvideo.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultcachedvideo module
+=================================
+
+.. automodule:: telegram.inlinequeryresultcachedvideo
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcachedvoice.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultcachedvoice module
+=================================
+
+.. automodule:: telegram.inlinequeryresultcachedvoice
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcontact.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultcontact module
+=================================
+
+.. automodule:: telegram.inlinequeryresultcontact
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultdocument.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultdocument module
+=================================
+
+.. automodule:: telegram.inlinequeryresultdocument
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultgif.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultgif module
+=================================
+
+.. automodule:: telegram.inlinequeryresultgif
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultlocation.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultlocation module
+=================================
+
+.. automodule:: telegram.inlinequeryresultlocation
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultmpeg4gif.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultmpeg4gif module
+=================================
+
+.. automodule:: telegram.inlinequeryresultmpeg4gif
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultphoto.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultphoto module
+=================================
+
+.. automodule:: telegram.inlinequeryresultphoto
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultvenue.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultvenue module
+=================================
+
+.. automodule:: telegram.inlinequeryresultvenue
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultvideo.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultvideo module
+=================================
+
+.. automodule:: telegram.inlinequeryresultvideo
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultvoice.rst

@@ -0,0 +1,7 @@
+telegram.inlinequeryresultvoice module
+=================================
+
+.. automodule:: telegram.inlinequeryresultvoice
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.rst

@@ -11,9 +11,30 @@ Submodules
    telegram.bot
    telegram.ext.updater
    telegram.ext.dispatcher
-   telegram.jobqueue
+   telegram.ext.jobqueue
    telegram.inlinequery
    telegram.inlinequeryresult
+   telegram.inlinekeyboardbutton
+   telegram.inlinekeyboardmarkup
+   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.inlinequeryresultgif
+   telegram.inlinequeryresultlocation
+   telegram.inlinequeryresultmpeg4gif
+   telegram.inlinequeryresultphoto
+   telegram.inlinequeryresultvenue
+   telegram.inlinequeryresultvideo
+   telegram.inlinequeryresultvoice
    telegram.choseninlineresult
    telegram.chataction
    telegram.contact

telegram/bot.py

@@ -208,8 +208,8 @@ class Bot(TelegramObject):
                 keyboard or to force a reply from the user.
             timeout (Optional[float]): If this value is specified, use it as
                 the definitive timeout (in seconds) for urlopen() operations.
-            network_delay  (Optional[float]): If using the timeout  (which
-                is a `timeout` for the Telegram servers operation),
+            network_delay (Optional[float]): If using the timeout (which is
+                a `timeout` for the Telegram servers operation),
                 then `network_delay` as an extra delay (in seconds) to
                 compensate for network latency. Defaults to 2.
 
@@ -258,8 +258,8 @@ class Bot(TelegramObject):
                 receive a notification with no sound.
             timeout (Optional[float]): If this value is specified, use it as
                 the definitive timeout (in seconds) for urlopen() operations.
-            network_delay  (Optional[float]): If using the timeout  (which
-                is a `timeout` for the Telegram servers operation),
+            network_delay (Optional[float]): If using the timeout (which is
+                a `timeout` for the Telegram servers operation),
                 then `network_delay` as an extra delay (in seconds) to
                 compensate for network latency. Defaults to 2.
 
@@ -317,8 +317,8 @@ class Bot(TelegramObject):
                 keyboard or to force a reply from the user.
             timeout (Optional[float]): If this value is specified, use it as
                 the definitive timeout (in seconds) for urlopen() operations.
-            network_delay  (Optional[float]): If using the timeout  (which
-                is a `timeout` for the Telegram servers operation),
+            network_delay (Optional[float]): If using the timeout (which is
+                a `timeout` for the Telegram servers operation),
                 then `network_delay` as an extra delay (in seconds) to
                 compensate for network latency. Defaults to 2.
 
@@ -387,8 +387,8 @@ class Bot(TelegramObject):
                 keyboard or to force a reply from the user.
             timeout (Optional[float]): If this value is specified, use it as
                 the definitive timeout (in seconds) for urlopen() operations.
-            network_delay  (Optional[float]): If using the timeout  (which
-                is a `timeout` for the Telegram servers operation),
+            network_delay (Optional[float]): If using the timeout (which is
+                a `timeout` for the Telegram servers operation),
                 then `network_delay` as an extra delay (in seconds) to
                 compensate for network latency. Defaults to 2.
 
@@ -447,8 +447,8 @@ class Bot(TelegramObject):
                 keyboard or to force a reply from the user.
             timeout (Optional[float]): If this value is specified, use it as
                 the definitive timeout (in seconds) for urlopen() operations.
-            network_delay  (Optional[float]): If using the timeout  (which
-                is a `timeout` for the Telegram servers operation),
+            network_delay (Optional[float]): If using the timeout (which is
+                a `timeout` for the Telegram servers operation),
                 then `network_delay` as an extra delay (in seconds) to
                 compensate for network latency. Defaults to 2.
 
@@ -499,8 +499,8 @@ class Bot(TelegramObject):
                 keyboard or to force a reply from the user.
             timeout (Optional[float]): If this value is specified, use it as
                 the definitive timeout (in seconds) for urlopen() operations.
-            network_delay  (Optional[float]): If using the timeout  (which
-                is a `timeout` for the Telegram servers operation),
+            network_delay (Optional[float]): If using the timeout (which is
+                a `timeout` for the Telegram servers operation),
                 then `network_delay` as an extra delay (in seconds) to
                 compensate for network latency. Defaults to 2.
 
@@ -556,8 +556,8 @@ class Bot(TelegramObject):
                 keyboard or to force a reply from the user.
             timeout (Optional[float]): If this value is specified, use it as
                 the definitive timeout (in seconds) for urlopen() operations.
-            network_delay  (Optional[float]): If using the timeout  (which
-                is a `timeout` for the Telegram servers operation),
+            network_delay (Optional[float]): If using the timeout (which is
+                a `timeout` for the Telegram servers operation),
                 then `network_delay` as an extra delay (in seconds) to
                 compensate for network latency. Defaults to 2.
 
@@ -618,8 +618,8 @@ class Bot(TelegramObject):
                 keyboard or to force a reply from the user.
             timeout (Optional[float]): If this value is specified, use it as
                 the definitive timeout (in seconds) for urlopen() operations.
-            network_delay  (Optional[float]): If using the timeout  (which
-                is a `timeout` for the Telegram servers operation),
+            network_delay (Optional[float]): If using the timeout (which is
+                a `timeout` for the Telegram servers operation),
                 then `network_delay` as an extra delay (in seconds) to
                 compensate for network latency. Defaults to 2.
 
@@ -671,8 +671,8 @@ class Bot(TelegramObject):
                 keyboard or to force a reply from the user.
             timeout (Optional[float]): If this value is specified, use it as
                 the definitive timeout (in seconds) for urlopen() operations.
-            network_delay  (Optional[float]): If using the timeout  (which
-                is a `timeout` for the Telegram servers operation),
+            network_delay (Optional[float]): If using the timeout (which is
+                a `timeout` for the Telegram servers operation),
                 then `network_delay` as an extra delay (in seconds) to
                 compensate for network latency. Defaults to 2.
 
@@ -733,8 +733,8 @@ class Bot(TelegramObject):
                 keyboard or to force a reply from the user.
             timeout (Optional[float]): If this value is specified, use it as
                 the definitive timeout (in seconds) for urlopen() operations.
-            network_delay  (Optional[float]): If using the timeout  (which
-                is a `timeout` for the Telegram servers operation),
+            network_delay (Optional[float]): If using the timeout (which is
+                a `timeout` for the Telegram servers operation),
                 then `network_delay` as an extra delay (in seconds) to
                 compensate for network latency. Defaults to 2.
 
@@ -794,8 +794,8 @@ class Bot(TelegramObject):
                 keyboard or to force a reply from the user.
             timeout (Optional[float]): If this value is specified, use it as
                 the definitive timeout (in seconds) for urlopen() operations.
-            network_delay  (Optional[float]): If using the timeout  (which
-                is a `timeout` for the Telegram servers operation),
+            network_delay (Optional[float]): If using the timeout (which is
+                a `timeout` for the Telegram servers operation),
                 then `network_delay` as an extra delay (in seconds) to
                 compensate for network latency. Defaults to 2.
 
@@ -1184,8 +1184,8 @@ class Bot(TelegramObject):
                 A JSON-serialized object for an inline keyboard.
             timeout (Optional[float]): If this value is specified, use it as
                 the definitive timeout (in seconds) for urlopen() operations.
-            network_delay  (Optional[float]): If using the timeout  (which
-                is a `timeout` for the Telegram servers operation),
+            network_delay (Optional[float]): If using the timeout (which is
+                a `timeout` for the Telegram servers operation),
                 then `network_delay` as an extra delay (in seconds) to
                 compensate for network latency. Defaults to 2.
 
@@ -1239,8 +1239,8 @@ class Bot(TelegramObject):
                 A JSON-serialized object for an inline keyboard.
             timeout (Optional[float]): If this value is specified, use it as
                 the definitive timeout (in seconds) for urlopen() operations.
-            network_delay  (Optional[float]): If using the timeout  (which
-                is a `timeout` for the Telegram servers operation),
+            network_delay (Optional[float]): If using the timeout (which is
+                a `timeout` for the Telegram servers operation),
                 then `network_delay` as an extra delay (in seconds) to
                 compensate for network latency. Defaults to 2.
 

telegram/inlinequeryresultarticle.py

@@ -39,6 +39,14 @@ class InlineQueryResultArticle(InlineQueryResult):
         thumb_width (int):
         thumb_height (int):
 
+    Deprecated: 4.0
+        message_text (str): Use :class:`InputTextMessageContent` instead.
+
+        parse_mode (str): Use :class:`InputTextMessageContent` instead.
+
+        disable_web_page_preview (bool): Use :class:`InputTextMessageContent`
+        instead.
+
     Args:
         id (str): Unique identifier for this result, 1-64 Bytes
         title (str):

telegram/inlinequeryresultaudio.py

@@ -39,6 +39,14 @@ class InlineQueryResultAudio(InlineQueryResult):
         input_message_content (Optional[
             :class:`telegram.input_message_content`]):
 
+    Deprecated: 4.0
+        message_text (str): Use :class:`InputTextMessageContent` instead.
+
+        parse_mode (str): Use :class:`InputTextMessageContent` instead.
+
+        disable_web_page_preview (bool): Use :class:`InputTextMessageContent`
+        instead.
+
     Args:
         audio_url (str):
         title (str):

telegram/message.py

@@ -62,6 +62,13 @@ class Message(TelegramObject):
         migrate_from_chat_id (int):
         channel_chat_created (bool):
 
+    Deprecated: 4.0
+        new_chat_participant (:class:`telegram.User`): Use `new_chat_member`
+        instead.
+
+        left_chat_participant  (:class:`telegram.User`): Use `left_chat_member`
+        instead.
+
     Args:
         message_id (int):
         from_user (:class:`telegram.User`):