Start Using Versioning Directives in Docs (python-telegram-bot#2252)

Poolitzer · web-flow · commit 2d7a974b8fd8 · 2020-12-17T19:05:12.000+01:00
* adding versioning in sphinx, closing python-telegram-bot#2250 * adding version requirement to contributors doc
diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst
@@ -91,6 +91,8 @@ Here's how to make a one-off code change.
 
      Once the process terminates, you can view the built documentation by opening ``docs/build/html/index.html`` with a browser.
 
+   - Add ``.. versionadded:: version``, ``.. versionchanged:: version`` or ``.. deprecated:: 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.
+
    - For consistency, please conform to `Google Python Style Guide`_ and `Google Python Style Docstrings`_.
 
    - The following exceptions to the above (Google's) style guides applies:
diff --git a/telegram/bot.py b/telegram/bot.py
@@ -595,6 +595,8 @@ def send_photo(
             filename (:obj:`str`, optional): Custom file name for the photo, when uploading a
                 new file. Convenience parameter, useful e.g. when sending files generated by the
                 :obj:`tempfile` module.
+
+                .. versionadded:: 13.1
             caption (:obj:`str`, optional): Photo caption (may also be used when resending photos
                 by file_id), 0-1024 characters after entities parsing.
             parse_mode (:obj:`str`, optional): Send Markdown or HTML, if you want Telegram apps to
@@ -691,6 +693,8 @@ def send_audio(
             filename (:obj:`str`, optional): Custom file name for the audio, when uploading a
                 new file. Convenience parameter, useful e.g. when sending files generated by the
                 :obj:`tempfile` module.
+
+                .. versionadded:: 13.1
             caption (:obj:`str`, optional): Audio caption, 0-1024 characters after entities
                 parsing.
             parse_mode (:obj:`str`, optional): Send Markdown or HTML, if you want Telegram apps to
@@ -970,6 +974,8 @@ def send_video(
             filename (:obj:`str`, optional): Custom file name for the video, when uploading a
                 new file. Convenience parameter, useful e.g. when sending files generated by the
                 :obj:`tempfile` module.
+
+                .. versionadded:: 13.1
             duration (:obj:`int`, optional): Duration of sent video in seconds.
             width (:obj:`int`, optional): Video width.
             height (:obj:`int`, optional): Video height.
@@ -1081,6 +1087,8 @@ def send_video_note(
             filename (:obj:`str`, optional): Custom file name for the video note, when uploading a
                 new file. Convenience parameter, useful e.g. when sending files generated by the
                 :obj:`tempfile` module.
+
+                .. versionadded:: 13.1
             duration (:obj:`int`, optional): Duration of sent video in seconds.
             length (:obj:`int`, optional): Video width and height, i.e. diameter of the video
                 message.
@@ -1175,6 +1183,8 @@ def send_animation(
             filename (:obj:`str`, optional): Custom file name for the animation, when uploading a
                 new file. Convenience parameter, useful e.g. when sending files generated by the
                 :obj:`tempfile` module.
+
+                .. versionadded:: 13.1
             duration (:obj:`int`, optional): Duration of sent animation in seconds.
             width (:obj:`int`, optional): Animation width.
             height (:obj:`int`, optional): Animation height.
@@ -1282,6 +1292,8 @@ def send_voice(
             filename (:obj:`str`, optional): Custom file name for the voice, when uploading a
                 new file. Convenience parameter, useful e.g. when sending files generated by the
                 :obj:`tempfile` module.
+
+                .. versionadded:: 13.1
             caption (:obj:`str`, optional): Voice message caption, 0-1024 characters after entities
                 parsing.
             parse_mode (:obj:`str`, optional): Send Markdown or HTML, if you want Telegram apps to
diff --git a/telegram/files/inputmedia.py b/telegram/files/inputmedia.py
@@ -81,6 +81,8 @@ class InputMediaAnimation(InputMedia):
         filename (:obj:`str`, optional): Custom file name for the animation, when uploading a
             new file. Convenience parameter, useful e.g. when sending files generated by the
             :obj:`tempfile` module.
+
+                .. versionadded:: 13.1
         thumb (`filelike object` | :class:`pathlib.Path`, optional): Thumbnail of the file sent;
             can be ignored if
             thumbnail generation for the file is supported server-side. The thumbnail should be
@@ -161,6 +163,8 @@ class InputMediaPhoto(InputMedia):
         filename (:obj:`str`, optional): Custom file name for the photo, when uploading a
             new file. Convenience parameter, useful e.g. when sending files generated by the
             :obj:`tempfile` module.
+
+                .. versionadded:: 13.1
         caption (:obj:`str`, optional ): Caption of the photo to be sent, 0-1024 characters after
             entities parsing.
         parse_mode (:obj:`str`, optional): Send Markdown or HTML, if you want Telegram apps to show
@@ -213,6 +217,8 @@ class InputMediaVideo(InputMedia):
         filename (:obj:`str`, optional): Custom file name for the video, when uploading a
             new file. Convenience parameter, useful e.g. when sending files generated by the
             :obj:`tempfile` module.
+
+                .. versionadded:: 13.1
         caption (:obj:`str`, optional): Caption of the video to be sent, 0-1024 characters after
             entities parsing.
         parse_mode (:obj:`str`, optional): Send Markdown or HTML, if you want Telegram apps to show
@@ -306,6 +312,8 @@ class InputMediaAudio(InputMedia):
         filename (:obj:`str`, optional): Custom file name for the audio, when uploading a
             new file. Convenience parameter, useful e.g. when sending files generated by the
             :obj:`tempfile` module.
+
+                .. versionadded:: 13.1
         caption (:obj:`str`, optional): Caption of the audio to be sent, 0-1024 characters after
             entities parsing.
         parse_mode (:obj:`str`, optional): Send Markdown or HTML, if you want Telegram apps to show
@@ -391,6 +399,8 @@ class InputMediaDocument(InputMedia):
         filename (:obj:`str`, optional): Custom file name for the document, when uploading a
             new file. Convenience parameter, useful e.g. when sending files generated by the
             :obj:`tempfile` module.
+
+                .. versionadded:: 13.1
         caption (:obj:`str`, optional): Caption of the document to be sent, 0-1024 characters after
             entities parsing.
         parse_mode (:obj:`str`, optional): Send Markdown or HTML, if you want Telegram apps to show
diff --git a/telegram/message.py b/telegram/message.py
@@ -982,6 +982,8 @@ def reply_copy(
                 this parameter will be ignored. Default: :obj:`True` in group chats and
                 :obj:`False` in private chats.
 
+                .. versionadded:: 13.1
+
         Returns:
             :class:`telegram.MessageId`: On success, returns the MessageId of the sent message.
 
