Bump version to v13.13

Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>

.deepsource.toml

@@ -5,6 +5,7 @@ test_patterns = ["tests/**"]
 exclude_patterns = [
     "tests/**",
     "docs/**",
+    "telegram/vendor/**",
     "setup.py",
     "setup-raw.py"
 ]

.git-blame-ignore-revs

@@ -1,7 +0,0 @@
-# .git-blame-ignore-revs
-# Use locally as `git blame file.py --ignore-revs-file .git-blame-ignore-revs`
-# or configure git to always use it: `git config blame.ignoreRevsFile .git-blame-ignore-revs`
-# First migration to code style Black (#2122)
-264b2c9c72691c5937b80e84e061c52dd2d8861a
-# Use Black more extensively (#2972)
-950d9a0751d79b92d78ea44344ce3e3c5b3948f9

.github/CONTRIBUTING.rst

@@ -1,11 +1,10 @@
-=================
 How To Contribute
 =================
 
 Every open source project lives from the generous help by contributors that sacrifice their time and ``python-telegram-bot`` is no different. To make participation as pleasant as possible, this project adheres to the `Code of Conduct`_ by the Python Software Foundation.
 
 Setting things up
-=================
+-----------------
 
 1. Fork the ``python-telegram-bot`` repository to your GitHub account.
 
@@ -13,7 +12,7 @@ Setting things up
 
    .. code-block:: bash
 
-      $ git clone https://github.com/<your username>/python-telegram-bot
+      $ git clone https://github.com/<your username>/python-telegram-bot --recursive
       $ cd python-telegram-bot
 
 3. Add a track to the original repository:
@@ -26,7 +25,7 @@ Setting things up
 
    .. code-block:: bash
 
-      $ pip install -r requirements-all.txt
+      $ pip install -r requirements.txt -r requirements-dev.txt
 
 
 5. Install pre-commit hooks:
@@ -36,18 +35,18 @@ Setting things up
       $ pre-commit install
 
 Finding something to do
-=======================
+#######################
 
 If you already know what you'd like to work on, you can skip this section.
 
 If you have an idea for something to do, first check if it's already been filed on the `issue tracker`_. If so, add a comment to the issue saying you'd like to work on it, and we'll help you get started! Otherwise, please file a new issue and assign yourself to it.
 
-Another great way to start contributing is by writing tests. Tests are really important because they help prevent developers from accidentally breaking existing code, allowing them to build cool things faster. If you're interested in helping out, let the development team know by posting to the `Telegram group`_, and we'll help you get started.
+Another great way to start contributing is by writing tests. Tests are really important because they help prevent developers from accidentally breaking existing code, allowing them to build cool things faster. If you're interested in helping out, let the development team know by posting to the `Telegram group`_ (use `@admins` to mention the maintainers), and we'll help you get started.
 
 That being said, we want to mention that we are very hesitant about adding new requirements to our projects. If you intend to do this, please state this in an issue and get a verification from one of the maintainers.
 
 Instructions for making a code change
-=====================================
+#####################################
 
 The central development branch is ``master``, which should be clean and ready for release at any time. In general, all changes should be done as feature branches based off of ``master``.
 
@@ -67,34 +66,66 @@ Here's how to make a one-off code change.
       $ git checkout -b your-branch-name
 
 3. **Make a commit to your feature branch**. Each commit should be self-contained and have a descriptive commit message that helps other developers understand why the changes were made.
-   We also have a check-list for PRs `below`_.
 
    - You can refer to relevant issues in the commit message by writing, e.g., "#105".
 
    - Your code should adhere to the `PEP 8 Style Guide`_, with the exception that we have a maximum line length of 99.
 
-   - Provide static typing with signature annotations. The documentation of `MyPy`_ will be a good start, the cheat sheet is `here`_. We also have some custom type aliases in ``telegram._utils.types``.
+   - Provide static typing with signature annotations. The documentation of `MyPy`_ will be a good start, the cheat sheet is `here`_. We also have some custom type aliases in ``telegram.utils.helpers.typing``.
 
-   - Document your code. This step is pretty important to us, so it has its own `section`_.
+   - Document your code. This project uses `sphinx`_ to generate static HTML docs. To build them, first make sure you have the required dependencies:
+
+     .. code-block:: bash
+
+        $ pip install -r docs/requirements-docs.txt
+
+     then run the following from the PTB root directory:
+   
+     .. code-block:: bash
+         
+        $ make -C docs html
+
+     or, if you don't have ``make`` available (e.g. on Windows):
+
+     .. code-block:: bash
+
+        $ sphinx-build docs/source docs/build/html
+
+     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. 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 consistency, please conform to `Google Python Style Guide`_ and `Google Python Style Docstrings`_.
 
    - The following exceptions to the above (Google's) style guides applies:
 
-     - Documenting types of global variables and complex types of class members can be done using the Sphinx docstring convention.
+        - Documenting types of global variables and complex types of class members can be done using the Sphinx docstring convention.
 
-   -  In addition, PTB uses some formatting/styling and linting tools in the pre-commit setup. Some of those tools also have command line tools that can help to run these tools outside of the pre-commit step. If you'd like to leverage that, please have a look at the `pre-commit config file`_ for an overview of which tools (and which versions of them) are used. For example, we use `Black`_ for code formatting. Plugins for Black exist for some `popular editors`_. You can use those instead of manually formatting everything.
+   -  In addition, PTB uses the `Black`_ coder formatting. Plugins for Black exist for some `popular editors`_. You can use those instead of manually formatting everything.
 
-   - Please ensure that the code you write is well-tested and that all automated tests still pass. We
-     have dedicated an `testing page`_ to help you with that.
+   - Please ensure that the code you write is well-tested.
 
-   - Don't break backward compatibility.
+   - Don’t break backward compatibility.
 
    - Add yourself to the AUTHORS.rst_ file in an alphabetical fashion.
 
+   - Before making a commit ensure that all automated tests still pass:
+
+     .. code-block::
+
+        $ pytest -v
+
+     To run ``test_official`` (particularly useful if you made API changes), run
+
+     .. code-block::
+
+        $ export TEST_OFFICIAL=true
+
+     prior to running the tests.
+
    - If you want run style & type checks before committing run
 
-     .. code-block:: bash
+     .. code-block::
 
         $ pre-commit run -a
 
@@ -120,13 +151,11 @@ Here's how to make a one-off code change.
 
 5. **Address review comments until all reviewers give LGTM ('looks good to me').**
 
-   - When your reviewer has reviewed the code, you'll get a notification. You'll need to respond in two ways:
+   - When your reviewer has reviewed the code, you'll get an email. You'll need to respond in two ways:
 
-     - Make a new commit addressing the comments you agree with, and push it to the same branch. Ideally, the commit message would explain what the commit does (e.g. "Fix lint error"), but if there are lots of disparate review comments, it's fine to refer to the original commit message and add something like "(address review comments)".
+       - Make a new commit addressing the comments you agree with, and push it to the same branch. Ideally, the commit message would explain what the commit does (e.g. "Fix lint error"), but if there are lots of disparate review comments, it's fine to refer to the original commit message and add something like "(address review comments)".
 
-     - In order to keep the commit history intact, please avoid squashing or amending history and then force-pushing to the PR. Reviewers often want to look at individual commits.
-
-     - In addition, please reply to each comment. Each reply should be either "Done" or a response explaining why the corresponding suggestion wasn't implemented. All comments must be resolved before LGTM can be given.
+       - In addition, please reply to each comment. Each reply should be either "Done" or a response explaining why the corresponding suggestion wasn't implemented. All comments must be resolved before LGTM can be given.
 
    - Resolve any merge conflicts that arise. To resolve conflicts between 'your-branch-name' (in your fork) and 'master' (in the ``python-telegram-bot`` repository), run:
 
@@ -140,6 +169,12 @@ Here's how to make a one-off code change.
         $ git commit -a
         $ git push origin your-branch-name
 
+   - If after merging you see local modified files in ``telegram/vendor/`` directory, that you didn't actually touch, that means you need to update submodules with this command:
+
+     .. code-block:: bash
+
+        $ git submodule update --init --recursive
+
    - At the end, the reviewer will merge the pull request.
 
 6. **Tidy up!** Delete the feature branch from both your local clone and the GitHub repository:
@@ -151,100 +186,11 @@ Here's how to make a one-off code change.
 
 7. **Celebrate.** Congratulations, you have contributed to ``python-telegram-bot``!
 
-Check-list for PRs
+Style commandments
 ------------------
 
-This checklist is a non-exhaustive reminder of things that should be done before a PR is merged, both for you as contributor and for the maintainers.
-Feel free to copy (parts of) the checklist to the PR description to remind you or the maintainers of open points or if you have questions on anything.
-
-- Added ``.. versionadded:: NEXT.VERSION``, ``.. versionchanged:: NEXT.VERSION`` or ``.. deprecated:: NEXT.VERSION`` to the docstrings for user facing changes (for methods/class descriptions, arguments and attributes)
-- 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
-- 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)**
-
-- Checked the Bot API specific sections of the `Stability Policy <https://docs.python-telegram-bot.org/stability_policy.html>`_
-- Created a PR to remove functionality deprecated in the previous Bot API release (`see here <https://docs.python-telegram-bot.org/en/stable/stability_policy.html#case-2>`_)
-
--  New classes:
-
-   - Added ``self._id_attrs`` and corresponding documentation
-   - ``__init__`` accepts ``api_kwargs`` as kw-only
-
--  Added new shortcuts:
-
-   - In :class:`~telegram.Chat` & :class:`~telegram.User` for all methods that accept ``chat/user_id``
-   - In :class:`~telegram.Message` for all methods that accept ``chat_id`` and ``message_id``
-   - For new :class:`~telegram.Message` shortcuts: Added ``quote`` argument if methods accepts ``reply_to_message_id``
-   - In :class:`~telegram.CallbackQuery` for all methods that accept either ``chat_id`` and ``message_id`` or ``inline_message_id``
-
--  If relevant:
-
-   - Added new constants at :mod:`telegram.constants` and shortcuts to them as class variables
-   - Link new and existing constants in docstrings instead of hard-coded numbers and strings
-   - Add new message types to :attr:`telegram.Message.effective_attachment`
-   - Added new handlers for new update types
-
-     - Add the handlers to the warning loop in the :class:`~telegram.ext.ConversationHandler`
-
-   - Added new filters for new message (sub)types
-   - Added or updated documentation for the changed class(es) and/or method(s)
-   - Added the new method(s) to ``_extbot.py``
-   - Added or updated ``bot_methods.rst``
-   - Updated the Bot API version number in all places: ``README.rst`` and ``README_RAW.rst`` (including the badge), as well as ``telegram.constants.BOT_API_VERSION_INFO``
-   - Added logic for arbitrary callback data in :class:`telegram.ext.ExtBot` for new methods that either accept a ``reply_markup`` in some form or have a return type that is/contains :class:`~telegram.Message`
-
-Documenting
-===========
-
-The documentation of this project is separated in two sections: User facing and dev facing.
-
-User facing docs are hosted at `RTD`_. They are the main way the users of our library are supposed to get information about the objects. They don't care about the internals, they just want to know
-what they have to pass to make it work, what it actually does. You can/should provide examples for non obvious cases (like the Filter module), and notes/warnings.
-
-Dev facing, on the other side, is for the devs/maintainers of this project. These
-doc strings don't have a separate documentation site they generate, instead, they document the actual code.
-
-User facing documentation
--------------------------
-We use `sphinx`_ to generate static HTML docs. To build them, first make sure you're running Python 3.9 or above and have the required dependencies:
-
-.. code-block:: bash
-
-   $ pip install -r docs/requirements-docs.txt
-
-then run the following from the PTB root directory:
-
-.. code-block:: bash
-
-   $ make -C docs html
-
-or, if you don't have ``make`` available (e.g. on Windows):
-
-.. code-block:: bash
-
-   $ sphinx-build docs/source docs/build/html
-
-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.
-
-Dev facing documentation
-------------------------
-We adhere to the `CSI`_ standard. This documentation is not fully implemented in the project, yet, but new code changes should comply with the `CSI` standard.
-The idea behind this is to make it very easy for you/a random maintainer or even a totally foreign person to drop anywhere into the code and more or less immediately understand what a particular line does. This will make it easier
-for new to make relevant changes if said lines don't do what they are supposed to.
-
-
-
-Style commandments
-==================
-
 Assert comparison order
------------------------
+#######################
 
 Assert statements should compare in **actual** == **expected** order.
 For example (assuming ``test_call`` is the thing being tested):
@@ -258,7 +204,7 @@ For example (assuming ``test_call`` is the thing being tested):
     assert 5 == test_call()
 
 Properly calling callables
---------------------------
+##########################
 
 Methods, functions and classes can specify optional parameters (with default
 values) using Python's keyword arg syntax. When providing a value to such a
@@ -275,23 +221,35 @@ callable we prefer that the call also uses keyword arg syntax. For example:
 This gives us the flexibility to re-order arguments and more importantly
 to add new required arguments. It's also more explicit and easier to read.
 
+Properly defining optional arguments
+####################################
 
-.. _`Code of Conduct`: https://www.python.org/psf/conduct/
+It's always good to not initialize optional arguments at class creation,
+instead use ``**kwargs`` to get them. It's well known Telegram API can
+change without notice, in that case if a new argument is added it won't
+break the API classes. For example:
+
+.. code-block:: python
+
+    # GOOD
+    def __init__(self, id, name, last_name=None, **kwargs):
+       self.last_name = last_name
+
+    # BAD
+    def __init__(self, id, name, last_name=None):
+       self.last_name = last_name
+
+
+.. _`Code of Conduct`: https://www.python.org/psf/codeofconduct/
 .. _`issue tracker`: https://github.com/python-telegram-bot/python-telegram-bot/issues
 .. _`Telegram group`: https://telegram.me/pythontelegrambotgroup
-.. _`PEP 8 Style Guide`: https://peps.python.org/pep-0008/
-.. _`sphinx`: https://www.sphinx-doc.org/en/master
-.. _`Google Python Style Guide`: https://google.github.io/styleguide/pyguide.html
+.. _`PEP 8 Style Guide`: https://www.python.org/dev/peps/pep-0008/
+.. _`sphinx`: http://sphinx-doc.org
+.. _`Google Python Style Guide`: http://google.github.io/styleguide/pyguide.html
 .. _`Google Python Style Docstrings`: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
-.. _AUTHORS.rst: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/AUTHORS.rst
+.. _AUTHORS.rst: ../AUTHORS.rst
 .. _`MyPy`: https://mypy.readthedocs.io/en/stable/index.html
 .. _`here`: https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html
-.. _`pre-commit config file`: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/.pre-commit-config.yaml
 .. _`Black`: https://black.readthedocs.io/en/stable/index.html
-.. _`popular editors`: https://black.readthedocs.io/en/stable/integrations/editors.html
-.. _`RTD`: https://docs.python-telegram-bot.org/
-.. _`RTD build`: https://docs.python-telegram-bot.org/en/doc-fixes
-.. _`CSI`: https://standards.mousepawmedia.com/en/stable/csi.html
-.. _`section`: #documenting
-.. _`testing page`: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/tests/README.rst
-.. _`below`: #check-list-for-prs
+.. _`popular editors`: https://black.readthedocs.io/en/stable/editor_integration.html
+.. _`RTD build`: https://python-telegram-bot.readthedocs.io/en/doc-fixes

.github/dependabot.yml

@@ -1,14 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "pip"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-      day: "friday"
-
-  # Updates the dependencies of the GitHub Actions workflows
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "monthly"
-      day: "friday"

.github/labeler.yml

@@ -1,9 +0,0 @@
-# Config file for workflows/labelling.yml
-
-version: 1
-
-labels:
-- label: "dependencies"
-  authors: ["dependabot[bot]", "pre-commit-ci[bot]"]
-- label: "code quality ✨"
-  authors: ["pre-commit-ci[bot]"]

.github/pull_request_template.md

@@ -1,6 +1,32 @@
 <!--
-Hey! You're PRing? Cool!
-Please be sure to check out our contribution guide (https://github.com/python-telegram-bot/python-telegram-bot/blob/master/.github/CONTRIBUTING.rst).
-Especially, please have a look at the check list for PRs (https://github.com/python-telegram-bot/python-telegram-bot/blob/master/.github/CONTRIBUTING.rst#check-list-for-prs). Feel free to copy (parts of) the checklist to the PR description to remind you or the maintainers of open points or if you have questions on anything.
+Hey! You're PRing? Cool! Please have a look at the below checklist. It's here to help both you and the maintainers to remember some aspects. Make sure to check out our contribution guide (https://github.com/python-telegram-bot/python-telegram-bot/blob/master/.github/CONTRIBUTING.rst).
 -->
 
+### Checklist for PRs
+
+- [ ] Added `.. versionadded:: version`, `.. versionchanged:: version` or `.. deprecated:: version` to the docstrings for user facing changes (for methods/class descriptions, arguments and attributes)
+- [ ] Created new or adapted existing unit tests
+- [ ] Added myself alphabetically to `AUTHORS.rst` (optional)
+- [ ] Added new classes & modules to the docs
+
+
+### If the PR contains API changes (otherwise, you can delete this passage)
+
+* New classes:
+    - [ ] Added `self._id_attrs` and corresponding documentation
+    - [ ] `__init__` accepts `**_kwargs`
+    
+* Added new shortcuts:
+    - [ ] In `Chat` & `User` for all methods that accept `chat/user_id`
+    - [ ] In `Message` for all methods that accept `chat_id` and `message_id`
+    - [ ] For new `Message` shortcuts: Added `quote` argument if methods accepts `reply_to_message_id`
+    - [ ] In `CallbackQuery` for all methods that accept either `chat_id` and `message_id` or `inline_message_id`
+    
+* If relevant:
+
+    - [ ] Added new constants at `telegram.constants` and shortcuts to them as class variables
+    - [ ] Added new handlers for new update types
+    - [ ] Added new filters for new message (sub)types
+    - [ ] Added or updated documentation for the changed class(es) and/or method(s)
+    - [ ] Updated the Bot API version number in all places: `README.rst` and `README_RAW.rst` (including the badge), as well as `telegram.constants.BOT_API_VERSION`
+    - [ ] Added logic for arbitrary callback data in `tg.ext.Bot` for new methods that either accept a `reply_markup` in some form or have a return type that is/contains `telegram.Message`

.github/stale.yml

@@ -0,0 +1,14 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 3
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 2
+# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
+onlyLabels: question
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking as stale. Set to `false` to disable
+markComment: false
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: >
+  This issue has been automatically closed due to inactivity. Feel free to comment in order to reopen
+  or ask again in our Telegram support group at https://t.me/pythontelegrambotgroup.

.github/workflows/dependabot-prs.yml

@@ -1,38 +0,0 @@
-name: Process Dependabot PRs
-
-on:
-  pull_request:
-    types: [opened, reopened]
-
-jobs:
-  process-dependabot-prs:
-    permissions:
-      pull-requests: read
-      contents: write
-
-    runs-on: ubuntu-latest
-    if: ${{ github.event.pull_request.user.login == 'dependabot[bot]' }}
-    steps:
-
-    - name: Fetch Dependabot metadata
-      id: dependabot-metadata
-      uses: dependabot/fetch-metadata@v1.6.1
-
-    - uses: actions/checkout@v3.5.2
-      with:
-        ref: ${{ github.event.pull_request.head.ref }}
-
-    - name: Update Version Number in Other Files
-      uses: jacobtomlinson/gha-find-replace@v3
-      with:
-        find: ${{ steps.dependabot-metadata.outputs.previous-version }}
-        replace: ${{ steps.dependabot-metadata.outputs.new-version }}
-        regex: false
-        exclude: CHANGES.rst
-
-    - name: Commit & Push Changes to PR
-      uses: EndBug/add-and-commit@v9.1.3
-      with:
-        message: 'Update version number in other files'
-        committer_name: GitHub Actions
-        committer_email: 41898282+github-actions[bot]@users.noreply.github.com

.github/workflows/docs-linkcheck.yml

@@ -1,27 +0,0 @@
-name: Check Links in Documentation
-on:
-  schedule:
-    # First day of month at 05:46 in every 2nd month
-    - cron: '46 5 1 */2 *'
-
-jobs:
-  test-sphinx-build:
-    name: test-sphinx-linkcheck
-    runs-on: ${{matrix.os}}
-    strategy:
-      matrix:
-        python-version: [3.9]
-        os: [ubuntu-latest]
-      fail-fast: False
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python -W ignore -m pip install --upgrade pip
-          python -W ignore -m pip install -r requirements-all.txt
-      - name: Check Links
-        run: sphinx-build docs/source docs/build/html -W --keep-going -j auto -b linkcheck

.github/workflows/docs.yml

@@ -1,47 +0,0 @@
-name: Test Documentation Build
-on:
-  pull_request:
-    branches:
-      - master
-      - doc-fixes
-  push:
-    branches:
-      - master
-      - doc-fixes
-
-jobs:
-  test-sphinx-build:
-    name: test-sphinx-build
-    runs-on: ${{matrix.os}}
-    strategy:
-      matrix:
-        python-version: [3.9]
-        os: [ubuntu-latest]
-      fail-fast: False
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-          cache: 'pip'
-          cache-dependency-path: '**/requirements*.txt'
-      - name: Install dependencies
-        run: |
-          python -W ignore -m pip install --upgrade pip
-          python -W ignore -m pip install -r requirements-all.txt
-      - name: Test autogeneration of admonitions
-        run: pytest -v --tb=short tests/docs/admonition_inserter.py
-      - name: Build docs
-        run: sphinx-build docs/source docs/build/html -W --keep-going -j auto
-      - name: Upload docs
-        uses: actions/upload-artifact@v3
-        with:
-          name: HTML Docs
-          retention-days: 7
-          path: |
-            # Exclude the .doctrees folder and .buildinfo file from the artifact
-            # since they are not needed and add to the size
-            docs/build/html/*
-            !docs/build/html/.doctrees
-            !docs/build/html/.buildinfo

.github/workflows/example_notifier.yml

@@ -0,0 +1,14 @@
+name: Warning maintainers
+on:
+  pull_request:
+    paths: examples/**
+jobs:
+  job:
+    runs-on: ubuntu-latest
+    name: about example change
+    steps:
+      - name: running the check
+        uses: Poolitzer/notifier-action@master
+        with:
+          notify-message: Hey there. Relax, I am just a little warning for the maintainers to release directly after merging your PR, otherwise we have broken examples and people might get confused :)
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/labelling.yml

@@ -1,17 +0,0 @@
-name: PR Labeler
-
-on:
-  pull_request:
-    types: [opened]
-
-jobs:
-  pre-commit-ci:
-    permissions:
-      contents: read # for srvaroa/labeler to read config file
-      pull-requests: write # for srvaroa/labeler to add labels in PR
-    runs-on: ubuntu-latest
-    steps:
-    - uses: srvaroa/labeler@v1.6.1
-      # Config file at .github/labeler.yml
-      env:
-        GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/lock.yml

@@ -3,15 +3,16 @@ name: 'Lock Closed Threads'
 on:
   schedule:
     - cron: '8 4 * * *'
+    - cron: '42 17 * * *'
 
 jobs:
   lock:
     runs-on: ubuntu-latest
     steps:
-      - uses: dessant/lock-threads@v4.0.1
+      - uses: dessant/lock-threads@v2.0.1
         with:
           github-token: ${{ github.token }}
-          issue-inactive-days: '7'
+          issue-lock-inactive-days: '7'
           issue-lock-reason: ''
-          pr-inactive-days: '7'
+          pr-lock-inactive-days: '7'
           pr-lock-reason: ''

.github/workflows/pre-commit_dependencies_notifier.yml

@@ -1,12 +1,10 @@
 name: Warning maintainers
 on:
-  pull_request_target:
+  pull_request:
     paths:
       - requirements.txt
-      - requirements-opts.txt
+      - requirements-dev.txt
       - .pre-commit-config.yaml
-permissions:
- pull-requests: write
 jobs:
   job:
     runs-on: ubuntu-latest
@@ -15,5 +13,5 @@ jobs:
       - name: running the check
         uses: Poolitzer/notifier-action@master
         with:
-          notify-message: Hey! Looks like you edited the (optional) requirements or the pre-commit hooks. I'm just a friendly reminder to keep the additional dependencies for the hooks in sync with the requirements :)
+          notify-message: Hey! Looks like you edited the (dev) requirements or the pre-commit hooks. I'm just a friendly reminder to keep the pre-commit hook versions in sync with the dev requirements and the additional dependencies for the hooks in sync with the requirements :)
           repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/readme_notifier.yml

@@ -1,11 +1,9 @@
 name: Warning maintainers
 on:
-  pull_request_target:
+  pull_request:
     paths:
       - README.rst
       - README_RAW.rst
-permissions:
- pull-requests: write
 jobs:
   job:
     runs-on: ubuntu-latest

.github/workflows/stale.yml

@@ -1,19 +0,0 @@
-name: 'Mark & close stale questions'
-on:
-  schedule:
-    - cron: '42 2 * * *'
-
-jobs:
-  stale:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/stale@v8
-        with:
-          # PRs never get stale
-          days-before-stale: 3
-          days-before-close: 2
-          days-before-pr-stale: -1
-          stale-issue-label: 'stale'
-          only-labels: 'question'
-          stale-issue-message: ''
-          close-issue-message: 'This issue has been automatically closed due to inactivity. Feel free to comment in order to reopen or ask again in our Telegram support group at https://t.me/pythontelegrambotgroup.'

.github/workflows/type_completeness.yml

@@ -1,69 +0,0 @@
-name: Check Type Completeness
-on:
-  pull_request:
-    branches:
-      - master
-  push:
-    branches:
-      - master
-
-jobs:
-  test-type-completeness:
-    name:   test-type-completeness
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - run: git fetch --depth=1  # https://github.com/actions/checkout/issues/329#issuecomment-674881489
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.9
-          cache: 'pip'
-          cache-dependency-path: '**/requirements*.txt'
-      - name: Install Pyright
-        run: |
-          python -W ignore -m pip install pyright~=1.1.316
-      - name: Get PR Completeness
-        # Must run before base completeness, as base completeness will checkout the base branch
-        # And we can't go back to the PR branch after that in case the PR is coming from a fork
-        run: |
-          pip install . -U
-          pyright --verifytypes telegram --ignoreexternal --outputjson > pr.json || true
-          pyright --verifytypes telegram --ignoreexternal > pr.readable || true
-      - name: Get Base Completeness
-        run: |
-          git checkout ${{ github.base_ref }}
-          pip install . -U
-          pyright --verifytypes telegram --ignoreexternal --outputjson > base.json || true
-      - name: Compare Completeness
-        uses: jannekem/run-python-script-action@v1
-        with:
-          script: |
-            import json
-            import os
-            from pathlib import Path
-
-            base = float(
-              json.load(open("base.json", "rb"))["typeCompleteness"]["completenessScore"]
-            )
-            pr = float(
-              json.load(open("pr.json", "rb"))["typeCompleteness"]["completenessScore"]
-            )
-            base_text = f"This PR changes type completeness from {round(base, 3)} to {round(pr, 3)}."
-            if pr < (base - 0.001):
-                text = f"{base_text} ❌"
-                set_summary(text)
-                print(Path("pr.readable").read_text(encoding="utf-8"))
-                error(text)
-                exit(1)
-            elif pr > (base + 0.001):
-                text = f"{base_text} ✨"
-                set_summary(text)
-                if pr < 1:
-                    print(Path("pr.readable").read_text(encoding="utf-8"))
-                print(text)
-            else:
-                text = f"{base_text} This is less than 0.1 percentage points. ✅"
-                set_summary(text)
-                print(Path("pr.readable").read_text(encoding="utf-8"))
-                print(text)

.gitignore

@@ -51,8 +51,6 @@ nosetests.xml
 coverage.xml
 *,cover
 .coveralls.yml
-.testmondata
-.testmondata-journal
 
 # Translations
 *.mo
@@ -71,9 +69,6 @@ target/
 # Sublime Text 2
 *.sublime*
 
-# VS Code
-.vscode
-
 # unitests files
 game.gif
 telegram.mp3

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "telegram/vendor/urllib3"]
+	path = telegram/vendor/ptb_urllib3
+	url = https://github.com/python-telegram-bot/urllib3.git
+	branch = ptb

.pre-commit-config.yaml

@@ -1,90 +1,64 @@
-# Make sure that the additional_dependencies here match requirements.txt
+# Make sure that
+#   * the revs specified here match requirements-dev.txt
+#   * the additional_dependencies here match requirements.txt
 
 ci:
-    autofix_prs: false
-    autoupdate_schedule: monthly
+    # We currently only need this behavior on the v13.x branch were we have the vendored urllib
+    submodules: true
 
 repos:
 -   repo: https://github.com/psf/black
-    rev: 23.7.0
+    rev: 22.3.0
     hooks:
     -   id: black
         args:
         - --diff
         - --check
--   repo: https://github.com/PyCQA/flake8
-    rev: 6.1.0
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.9.2
     hooks:
     -   id: flake8
 -   repo: https://github.com/PyCQA/pylint
-    rev: v3.0.0a6
+    rev: v2.8.3
     hooks:
     -   id: pylint
         files: ^(telegram|examples)/.*\.py$
         args:
           - --rcfile=setup.cfg
-          #  run pylint across multiple cpu cores to speed it up-
-          # https://pylint.pycqa.org/en/latest/user_guide/run.html?#parallel-execution to know more
-          - --jobs=0
-
         additional_dependencies:
-          - httpx~=0.24.1
-          - tornado~=6.2
-          - APScheduler~=3.10.4
-          - cachetools~=5.3.1
-          - aiolimiter~=1.1.0
+          - certifi
+          - tornado>=6.1
+          - APScheduler==3.6.3
+          - cachetools==4.2.2
           - . # this basically does `pip install -e .`
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.4.1
+    rev: v0.812
     hooks:
     -   id: mypy
         name: mypy-ptb
         files: ^telegram/.*\.py$
         additional_dependencies:
-          - types-pytz
-          - types-cryptography
-          - types-cachetools
-          - httpx~=0.24.1
-          - tornado~=6.2
-          - APScheduler~=3.10.4
-          - cachetools~=5.3.1
-          - aiolimiter~=1.1.0
+          - certifi
+          - tornado>=6.1
+          - APScheduler==3.6.3
+          - cachetools==4.2.2
+          - . # this basically does `pip install -e .`
+    -   id: mypy
+        name: mypy-examples
+        files: ^examples/.*\.py$
+        args:
+          - --no-strict-optional
+          - --follow-imports=silent
+        additional_dependencies:
+          - certifi
+          - tornado>=6.1
+          - APScheduler==3.6.3
+          - cachetools==4.2.2
           - . # this basically does `pip install -e .`
-    - id: mypy
-      name: mypy-examples
-      files: ^examples/.*\.py$
-      args:
-        - --no-strict-optional
-        - --follow-imports=silent
-      additional_dependencies:
-        - tornado~=6.2
-        - APScheduler~=3.10.4
-        - cachetools~=5.3.1
-        - . # this basically does `pip install -e .`
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v3.10.1
+    rev: v2.19.1
     hooks:
     -   id: pyupgrade
-        files: ^(telegram|examples|tests|docs)/.*\.py$
-        args:
-          - --py38-plus
--   repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-    -   id: isort
-        name: isort
-        args:
-        - --diff
-        - --check
--   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.0.281'
-    hooks:
-    -   id: ruff
-        name: ruff
         files: ^(telegram|examples|tests)/.*\.py$
-        additional_dependencies:
-          - httpx~=0.24.1
-          - tornado~=6.2
-          - APScheduler~=3.10.4
-          - cachetools~=5.3.1
-          - aiolimiter~=1.1.0
+        args:
+          - --py36-plus

.readthedocs.yml

@@ -15,37 +15,8 @@ formats:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
+   version: 3
    install:
      - method: pip
        path: .
      - requirements: docs/requirements-docs.txt
-
-build:
-   os: ubuntu-22.04
-   tools:
-      python: "3"  # latest stable cpython version
-
-search:
-   ranking:  # bump up rank of commonly searched pages: (default: 0, values range from -10 to 10)
-      telegram.bot.html: 7
-      telegram.message.html: 3
-      telegram.update.html: 3
-      telegram.user.html: 2
-      telegram.chat.html: 2
-      telegram.ext.application.html: 3
-      telegram.ext.filters.html: 3
-      telegram.ext.callbackcontext.html: 2
-      telegram.ext.inlinekeyboardbutton.html: 1
-
-      telegram.passport*.html: -7
-
-   ignore:
-      - changelog.html
-      - coc.html
-      - bot_methods.html#
-      - bot_methods.html
-      # Defaults
-      - search.html
-      - search/index.html
-      - 404.html
-      - 404/index.html'

AUTHORS.rst

@@ -9,32 +9,33 @@ The current development team includes
 - `Poolitzer <https://github.com/Poolitzer>`_ (community liaison)
 - `Shivam <https://github.com/Starry69>`_
 - `Harshil <https://github.com/harshil21>`_
-- `Dmitry Kolomatskiy <https://github.com/lemontree210>`_
-- `Aditya <https://github.com/clot27>`_
 
 Emeritus maintainers include
 `Jannes Höke <https://github.com/jh0ker>`_ (`@jh0ker <https://t.me/jh0ker>`_ on Telegram),
 `Noam Meltzer <https://github.com/tsnoam>`_, `Pieter Schutz <https://github.com/eldinnie>`_ and `Jasmin Bom <https://github.com/jsmnbom>`_.
 
+Vendored packages
+-----------------
+
+We're vendoring urllib3 as part of ``python-telegram-bot`` which is distributed under the MIT
+license. For more info, full credits & license terms, the sources can be found here:
+`https://github.com/python-telegram-bot/urllib3`.
+
 Contributors
 ------------
 
 The following wonderful people contributed directly or indirectly to this project:
 
-- `Abdelrahman <https://github.com/aelkheir>`_
 - `Abshar <https://github.com/abxhr>`_
 - `Alateas <https://github.com/alateas>`_
 - `Ales Dokshanin <https://github.com/alesdokshanin>`_
-- `Alizia <https://github.com/thefunkycat>`_
 - `Ambro17 <https://github.com/Ambro17>`_
 - `Andrej Zhilenkov <https://github.com/Andrej730>`_
 - `Anton Tagunov <https://github.com/anton-tagunov>`_
 - `Avanatiker <https://github.com/Avanatiker>`_
 - `Balduro <https://github.com/Balduro>`_
 - `Bibo-Joshi <https://github.com/Bibo-Joshi>`_
-- `Biruk Alamirew <https://github.com/BAcode-X>`_
 - `bimmlerd <https://github.com/bimmlerd>`_
-- `cyc8 <https://github.com/cyc8>`_ 
 - `d-qoi <https://github.com/d-qoi>`_
 - `daimajia <https://github.com/daimajia>`_
 - `Daniel Reed <https://github.com/nmlorg>`_
@@ -42,7 +43,6 @@ The following wonderful people contributed directly or indirectly to this projec
 - `DonalDuck004 <https://github.com/DonalDuck004>`_
 - `Eana Hufwe <https://github.com/blueset>`_
 - `Ehsan Online <https://github.com/ehsanonline>`_
-- `Eldad Carin <https://github.com/eldbud>`_
 - `Eli Gao <https://github.com/eligao>`_
 - `Emilio Molinari <https://github.com/xates>`_
 - `ErgoZ Riftbit Vaper <https://github.com/ergoz>`_
@@ -51,14 +51,12 @@ The following wonderful people contributed directly or indirectly to this projec
 - `Evan Haberecht <https://github.com/habereet>`_
 - `Evgeny Denisov <https://github.com/eIGato>`_
 - `evgfilim1 <https://github.com/evgfilim1>`_
-- `ExalFabu <https://github.com/ExalFabu>`_
 - `franciscod <https://github.com/franciscod>`_
 - `gamgi <https://github.com/gamgi>`_
 - `Gauthamram Ravichandran <https://github.com/GauthamramRavichandran>`_
 - `Harshil <https://github.com/harshil21>`_
 - `Hugo Damer <https://github.com/HakimusGIT>`_
 - `ihoru <https://github.com/ihoru>`_
-- `Iulian Onofrei <https://github.com/revolter>`_
 - `Jasmin Bom <https://github.com/jsmnbom>`_
 - `JASON0916 <https://github.com/JASON0916>`_
 - `jeffffc <https://github.com/jeffffc>`_
@@ -69,19 +67,14 @@ The following wonderful people contributed directly or indirectly to this projec
 - `Joscha Götzer <https://github.com/Rostgnom>`_
 - `jossalgon <https://github.com/jossalgon>`_
 - `JRoot3D <https://github.com/JRoot3D>`_
-- `kennethcheo <https://github.com/kennethcheo>`_
 - `Kirill Vasin <https://github.com/vasinkd>`_
 - `Kjwon15 <https://github.com/kjwon15>`_
 - `Li-aung Yip <https://github.com/LiaungYip>`_
 - `Loo Zheng Yuan <https://github.com/loozhengyuan>`_
 - `LRezende <https://github.com/lrezende>`_
-- `Luca Bellanti <https://github.com/Trifase>`_
 - `macrojames <https://github.com/macrojames>`_
 - `Matheus Lemos <https://github.com/mlemosf>`_
-- `Michael Dix <https://github.com/Eisberge>`_
 - `Michael Elovskikh <https://github.com/wronglink>`_
-- `Miguel C. R. <https://github.com/MiguelX413>`_
-- `miles <https://github.com/miles170>`_
 - `Mischa Krüger <https://github.com/Makman2>`_
 - `naveenvhegde <https://github.com/naveenvhegde>`_
 - `neurrone <https://github.com/neurrone>`_
@@ -96,19 +89,15 @@ The following wonderful people contributed directly or indirectly to this projec
 - `Paradox <https://github.com/paradox70>`_
 - `Patrick Hofmann <https://github.com/PH89>`_
 - `Paul Larsen <https://github.com/PaulSonOfLars>`_
-- `Pawan <https://github.com/pawanrai9999>`_
 - `Pieter Schutz <https://github.com/eldinnie>`_
-- `Piraty <https://github.com/piraty>`_
 - `Poolitzer <https://github.com/Poolitzer>`_
 - `Pranjalya Tiwari <https://github.com/Pranjalya>`_
 - `Rahiel Kasim <https://github.com/rahiel>`_
 - `Riko Naka <https://github.com/rikonaka>`_
 - `Rizlas <https://github.com/rizlas>`_
 - `Sahil Sharma <https://github.com/sahilsharma811>`_
-- `Sam Mosleh <https://github.com/sam-mosleh>`_
 - `Sascha <https://github.com/saschalalala>`_
 - `Shelomentsev D <https://github.com/shelomentsevd>`_
-- `Shivam Saini <https://github.com/shivamsn97>`_
 - `Simon Schürrle <https://github.com/SitiSchu>`_
 - `sooyhwang <https://github.com/sooyhwang>`_
 - `syntx <https://github.com/syntx>`_
@@ -120,11 +109,7 @@ The following wonderful people contributed directly or indirectly to this projec
 - `Vorobjev Simon <https://github.com/simonvorobjev>`_
 - `Wagner Macedo <https://github.com/wagnerluis1982>`_
 - `wjt <https://github.com/wjt>`_
-- `Yaw Danso <https://github.com/dglitxh>`_
-- `Yao Kuan <https://github.com/thatguylah>`_
 - `zeroone2numeral2 <https://github.com/zeroone2numeral2>`_
 - `zeshuaro <https://github.com/zeshuaro>`_
-- `zpavloudis <https://github.com/zpavloudis>`_
-
 
 Please add yourself here alphabetically when you submit your first pull request.

CODE_OF_CONDUCT.md

@@ -1,14 +1,10 @@
-====================================
-Contributor Covenant Code of Conduct
-====================================
+# Contributor Covenant Code of Conduct
 
-Our Pledge
-==========
+## Our Pledge
 
 In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
 
-Our Standards
-=============
+## Our Standards
 
 Examples of behavior that contributes to creating a positive environment include:
 
@@ -27,26 +23,25 @@ Examples of unacceptable behavior by participants include:
 * Publishing others' private information, such as a physical or electronic address, without explicit permission
 * Other conduct which could reasonably be considered inappropriate in a professional setting
 
-Our Responsibilities
-====================
+## Our Responsibilities
 
 Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
 
 Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
 
-Scope
-=====
+## Scope
 
 This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
 
-Enforcement
-===========
+## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at devs@python-telegram-bot.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 
-Attribution
-===========
+## Attribution
 
-This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org>`_, version 1.4, available at `https://www.contributor-covenant.org/version/1/4 <https://www.contributor-covenant.org/version/1/4/>`_.
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

MANIFEST.in

@@ -1 +1 @@
-include LICENSE LICENSE.lesser requirements.txt requirements-opts.txt README_RAW.rst telegram/py.typed
+include LICENSE LICENSE.lesser Makefile requirements.txt README_RAW.rst telegram/py.typed

README.rst

@@ -1,11 +1,17 @@
 ..
     Make sure to apply any changes to this file to README_RAW.rst as well!
 
-.. image:: https://raw.githubusercontent.com/python-telegram-bot/logos/master/logo-text/png/ptb-logo-text_768.png
+.. image:: https://github.com/python-telegram-bot/logos/blob/master/logo-text/png/ptb-logo-text_768.png?raw=true
    :align: center
    :target: https://python-telegram-bot.org
    :alt: python-telegram-bot Logo
 
+We have made you a wrapper you can't refuse
+
+We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us!
+
+*Stay tuned for library updates and new releases on our* `Telegram Channel <https://telegram.me/pythontelegrambotchannel>`_.
+
 .. image:: https://img.shields.io/pypi/v/python-telegram-bot.svg
    :target: https://pypi.org/project/python-telegram-bot/
    :alt: PyPi Package Version
@@ -14,7 +20,7 @@
    :target: https://pypi.org/project/python-telegram-bot/
    :alt: Supported Python versions
 
-.. image:: https://img.shields.io/badge/Bot%20API-6.8-blue?logo=telegram
+.. image:: https://img.shields.io/badge/Bot%20API-6.1-blue?logo=telegram
    :target: https://core.telegram.org/bots/api-changelog
    :alt: Supported Bot API versions
 
@@ -23,202 +29,213 @@
    :alt: PyPi Package Monthly Download
 
 .. image:: https://readthedocs.org/projects/python-telegram-bot/badge/?version=stable
-   :target: https://docs.python-telegram-bot.org/en/stable/
+   :target: https://python-telegram-bot.readthedocs.io/en/stable/?badge=stable
    :alt: Documentation Status
 
 .. image:: https://img.shields.io/pypi/l/python-telegram-bot.svg
    :target: https://www.gnu.org/licenses/lgpl-3.0.html
    :alt: LGPLv3 License
 
-.. image:: https://github.com/python-telegram-bot/python-telegram-bot/workflows/Unit%20Tests/badge.svg
+.. image:: https://github.com/python-telegram-bot/python-telegram-bot/workflows/GitHub%20Actions/badge.svg
    :target: https://github.com/python-telegram-bot/python-telegram-bot/
    :alt: Github Actions workflow
 
 .. image:: https://codecov.io/gh/python-telegram-bot/python-telegram-bot/branch/master/graph/badge.svg
-   :target: https://app.codecov.io/gh/python-telegram-bot/python-telegram-bot
+   :target: https://codecov.io/gh/python-telegram-bot/python-telegram-bot
    :alt: Code coverage
 
-.. image:: https://isitmaintained.com/badge/resolution/python-telegram-bot/python-telegram-bot.svg
-   :target: https://isitmaintained.com/project/python-telegram-bot/python-telegram-bot
+.. image:: http://isitmaintained.com/badge/resolution/python-telegram-bot/python-telegram-bot.svg
+   :target: http://isitmaintained.com/project/python-telegram-bot/python-telegram-bot
    :alt: Median time to resolve an issue
 
 .. image:: https://api.codacy.com/project/badge/Grade/99d901eaa09b44b4819aec05c330c968
-   :target: https://app.codacy.com/gh/python-telegram-bot/python-telegram-bot/dashboard
+   :target: https://www.codacy.com/app/python-telegram-bot/python-telegram-bot?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=python-telegram-bot/python-telegram-bot&amp;utm_campaign=Badge_Grade
    :alt: Code quality: Codacy
 
-.. image:: https://app.deepsource.com/gh/python-telegram-bot/python-telegram-bot.svg/?label=active+issues
-   :target: https://app.deepsource.com/gh/python-telegram-bot/python-telegram-bot/?ref=repository-badge
+.. image:: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot.svg/?label=active+issues
+   :target: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot/?ref=repository-badge
    :alt: Code quality: DeepSource
 
-.. image:: https://results.pre-commit.ci/badge/github/python-telegram-bot/python-telegram-bot/master.svg
-   :target: https://results.pre-commit.ci/latest/github/python-telegram-bot/python-telegram-bot/master
-   :alt: pre-commit.ci status
-
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
-   :alt: Code Style: Black
-
-.. image:: https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram
-   :target: https://t.me/pythontelegrambotchannel
-   :alt: Telegram Channel
 
 .. image:: https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram
    :target: https://telegram.me/pythontelegrambotgroup
    :alt: Telegram Group
 
-We have made you a wrapper you can't refuse
+=================
+Table of contents
+=================
 
-We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us!
+- `Introduction`_
 
-*Stay tuned for library updates and new releases on our* `Telegram Channel <https://telegram.me/pythontelegrambotchannel>`_.
+- `Telegram API support`_
 
+- `Installing`_
+
+- `Getting started`_
+
+  #. `Learning by example`_
+
+  #. `Logging`_
+
+  #. `Documentation`_
+
+- `Getting help`_
+
+- `Contributing`_
+
+- `License`_
+
+
+============
 Introduction
 ============
 
-This library provides a pure Python, asynchronous interface for the
+This library provides a pure Python interface for the
 `Telegram Bot API <https://core.telegram.org/bots/api>`_.
-It's compatible with Python versions **3.8+**.
+It's compatible with Python versions 3.7+. PTB might also work on `PyPy <http://pypy.org/>`_, though there have been a lot of issues before. Hence, PyPy is not officially supported.
 
 In addition to the pure API implementation, this library features a number of high-level classes to
 make the development of bots easy and straightforward. These classes are contained in the
 ``telegram.ext`` submodule.
 
-A pure API implementation *without* ``telegram.ext`` is available as the standalone package ``python-telegram-bot-raw``.  `See here for details. <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/README_RAW.rst>`_
+A pure API implementation *without* ``telegram.ext`` is available as the standalone package ``python-telegram-bot-raw``.  `See here for details. <https://github.com/python-telegram-bot/python-telegram-bot/blob/v13.x/README_RAW.rst>`_
 
+----
 Note
 ----
 
 Installing both ``python-telegram-bot`` and ``python-telegram-bot-raw`` in conjunction will result in undesired side-effects, so only install *one* of both.
 
+====================
 Telegram API support
 ====================
 
-All types and methods of the Telegram Bot API **6.8** are supported.
+All types and methods of the Telegram Bot API **6.1** are supported.
 
+==========
 Installing
 ==========
 
-You can install or upgrade ``python-telegram-bot`` via
+You can install or upgrade python-telegram-bot with:
 
 .. code:: shell
 
     $ pip install python-telegram-bot --upgrade
 
-To install a pre-release, use the ``--pre`` `flag <https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-pre>`_ in addition.
-
-You can also install ``python-telegram-bot`` from source, though this is usually not necessary.
+Or you can install from source with:
 
 .. code:: shell
 
-    $ git clone https://github.com/python-telegram-bot/python-telegram-bot
+    $ git clone https://github.com/python-telegram-bot/python-telegram-bot --recursive
     $ cd python-telegram-bot
     $ python setup.py install
+    
+In case you have a previously cloned local repository already, you should initialize the added urllib3 submodule before installing with:
 
-Verifying Releases
-------------------
+.. code:: shell
 
-We sign all the releases with a GPG key.
-The signatures are uploaded to both the `GitHub releases page <https://github.com/python-telegram-bot/python-telegram-bot/releases>`_ and the `PyPI project <https://pypi.org/project/python-telegram-bot/>`_ and end with a suffix ``.asc``.
-Please find the public keys `here <https://github.com/python-telegram-bot/python-telegram-bot/tree/master/public_keys>`_.
-The keys are named in the format ``<first_version>-<last_version>.gpg`` or ``<first_version>-current.gpg`` if the key is currently being used for new releases.
-
-In addition, the GitHub release page also contains the sha1 hashes of the release files in the files with the suffix ``.sha1``.
-
-This allows you to verify that a release file that you downloaded was indeed provided by the ``python-telegram-bot`` team.
-
-Dependencies & Their Versions
------------------------------
-
-``python-telegram-bot`` tries to use as few 3rd party dependencies as possible.
-However, for some features using a 3rd party library is more sane than implementing the functionality again.
-As these features are *optional*, the corresponding 3rd party dependencies are not installed by default.
-Instead, they are listed as optional dependencies.
-This allows to avoid unnecessary dependency conflicts for users who don't need the optional features.
-
-The only required dependency is `httpx ~= 0.24.1 <https://www.python-httpx.org>`_ for
-``telegram.request.HTTPXRequest``, the default networking backend.
-
-``python-telegram-bot`` is most useful when used along with additional libraries.
-To minimize dependency conflicts, we try to be liberal in terms of version requirements on the (optional) dependencies.
-On the other hand, we have to ensure stability of ``python-telegram-bot``, which is why we do apply version bounds.
-If you encounter dependency conflicts due to these bounds, feel free to reach out.
+    $ git submodule update --init --recursive
 
+---------------------
 Optional Dependencies
-#####################
+---------------------
 
 PTB can be installed with optional dependencies:
 
-* ``pip install "python-telegram-bot[passport]"`` installs the `cryptography>=39.0.1 <https://cryptography.io/en/stable>`_ library. Use this, if you want to use Telegram Passport related functionality.
-* ``pip install "python-telegram-bot[socks]"`` installs `httpx[socks] <https://www.python-httpx.org/#dependencies>`_. Use this, if you want to work behind a Socks5 server.
-* ``pip install "python-telegram-bot[http2]"`` installs `httpx[http2] <https://www.python-httpx.org/#dependencies>`_. Use this, if you want to use HTTP/2.
-* ``pip install "python-telegram-bot[rate-limiter]"`` installs `aiolimiter~=1.1.0 <https://aiolimiter.readthedocs.io/en/stable/>`_. Use this, if you want to use ``telegram.ext.AIORateLimiter``.
-* ``pip install "python-telegram-bot[webhooks]"`` installs the `tornado~=6.2 <https://www.tornadoweb.org/en/stable/>`_ library. Use this, if you want to use ``telegram.ext.Updater.start_webhook``/``telegram.ext.Application.run_webhook``.
-* ``pip install "python-telegram-bot[callback-data]"`` installs the `cachetools~=5.3.1 <https://cachetools.readthedocs.io/en/latest/>`_ library. Use this, if you want to use `arbitrary callback_data <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Arbitrary-callback_data>`_.
-* ``pip install "python-telegram-bot[job-queue]"`` installs the `APScheduler~=3.10.4 <https://apscheduler.readthedocs.io/en/3.x/>`_ library and enforces `pytz>=2018.6 <https://pypi.org/project/pytz/>`_, where ``pytz`` is a dependency of ``APScheduler``. Use this, if you want to use the ``telegram.ext.JobQueue``.
+* ``pip install python-telegram-bot[passport]`` installs the `cryptography <https://cryptography.io>`_ library. Use this, if you want to use Telegram Passport related functionality.
+* ``pip install python-telegram-bot[ujson]`` installs the `ujson <https://pypi.org/project/ujson/>`_ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard `json <https://docs.python.org/3/library/json.html>`_ library.
+* ``pip install python-telegram-bot[socks]`` installs the `PySocks <https://pypi.org/project/PySocks/>`_ library. Use this, if you want to work behind a Socks5 server.
 
-To install multiple optional dependencies, separate them by commas, e.g. ``pip install "python-telegram-bot[socks,webhooks]"``.
+===============
+Getting started
+===============
 
-Additionally, two shortcuts are provided:
+Our Wiki contains a lot of resources to get you started with ``python-telegram-bot``:
 
-* ``pip install "python-telegram-bot[all]"`` installs all optional dependencies.
-* ``pip install "python-telegram-bot[ext]"`` installs all optional dependencies that are related to ``telegram.ext``, i.e. ``[rate-limiter, webhooks, callback-data, job-queue]``.
+- `Introduction to the API <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Introduction-to-the-API>`_
+- Tutorial: `Your first Bot <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Extensions-%E2%80%93-Your-first-Bot>`_
 
-Quick Start
-===========
+Other references:
 
-Our Wiki contains an `Introduction to the API <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Introduction-to-the-API>`_ explaining how the pure Bot API can be accessed via ``python-telegram-bot``.
-Moreover, the `Tutorial: Your first Bot <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Extensions---Your-first-Bot>`_ gives an introduction on how chatbots can be easily programmed with the help of the ``telegram.ext`` module.
+- `Telegram API documentation <https://core.telegram.org/bots/api>`_
+- `python-telegram-bot documentation <https://python-telegram-bot.readthedocs.io/>`_
 
-Resources
-=========
+-------------------
+Learning by example
+-------------------
 
-- The `package documentation <https://docs.python-telegram-bot.org/>`_ is the technical reference for ``python-telegram-bot``.
-  It contains descriptions of all available classes, modules, methods and arguments as well as the `changelog <https://docs.python-telegram-bot.org/changelog.html>`_.
-- The `wiki <https://github.com/python-telegram-bot/python-telegram-bot/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 <https://docs.python-telegram-bot.org/examples.html>`_ 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 <https://core.telegram.org/bots/api>`_ is of course always worth a read.
+We believe that the best way to learn this package is by example. Here
+are some examples for you to review. 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. Best of all,
+the code for these examples are released to the public domain, so you can start by grabbing the
+code and building on top of it.
 
+Visit `this page <https://github.com/python-telegram-bot/python-telegram-bot/blob/v13.x/examples/README.md>`_ to discover the official examples or look at the examples on the `wiki <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Examples>`_ to see other bots the community has built.
+
+-------
+Logging
+-------
+
+This library uses the ``logging`` module. To set up logging to standard output, put:
+
+.. code:: python
+
+    import logging
+    logging.basicConfig(level=logging.DEBUG,
+                        format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+
+at the beginning of your script.
+
+You can also use logs in your application by calling ``logging.getLogger()`` and setting the log level you want:
+
+.. code:: python
+
+    logger = logging.getLogger()
+    logger.setLevel(logging.INFO)
+
+If you want DEBUG logs instead:
+
+.. code:: python
+
+    logger.setLevel(logging.DEBUG)
+
+
+=============
+Documentation
+=============
+
+``python-telegram-bot``'s documentation lives at `readthedocs.io <https://python-telegram-bot.readthedocs.io/>`_.
+
+============
 Getting help
 ============
 
-If the resources mentioned above don't answer your questions or simply overwhelm you, there are several ways of getting help.
+You can get help in several ways:
 
-1. We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us! Asking a question here is often the quickest way to get a pointer in the right direction.
+1. We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us!
 
-2. Ask questions by opening `a discussion <https://github.com/python-telegram-bot/python-telegram-bot/discussions/new>`_.
+2. Report bugs, request new features or ask questions by `creating an issue <https://github.com/python-telegram-bot/python-telegram-bot/issues/new/choose>`_ or `a discussion <https://github.com/python-telegram-bot/python-telegram-bot/discussions/new>`_.
 
-3. You can even ask for help on Stack Overflow using the `python-telegram-bot tag <https://stackoverflow.com/questions/tagged/python-telegram-bot>`_.
+3. Our `Wiki pages <https://github.com/python-telegram-bot/python-telegram-bot/wiki/>`_ offer a growing amount of resources.
 
-Concurrency
-===========
+4. You can even ask for help on Stack Overflow using the `python-telegram-bot tag <https://stackoverflow.com/questions/tagged/python-telegram-bot>`_.
 
-Since v20.0, ``python-telegram-bot`` is built on top of Pythons ``asyncio`` module.
-Because ``asyncio`` is in general single-threaded, ``python-telegram-bot`` does currently not aim to be thread-safe.
-Noteworthy parts of ``python-telegram-bots`` API that are likely to cause issues (e.g. race conditions) when used in a multi-threaded setting include:
-
-* ``telegram.ext.Application/Updater.update_queue``
-* ``telegram.ext.ConversationHandler.check/handle_update``
-* ``telegram.ext.CallbackDataCache``
-* ``telegram.ext.BasePersistence``
-* all classes in the ``telegram.ext.filters`` module that allow to add/remove allowed users/chats at runtime
 
+============
 Contributing
 ============
 
-Contributions of all sizes are welcome.
-Please review our `contribution guidelines <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/.github/CONTRIBUTING.rst>`_ to get started.
-You can also help by `reporting bugs or feature requests <https://github.com/python-telegram-bot/python-telegram-bot/issues/new/choose>`_.
+Contributions of all sizes are welcome. Please review our `contribution guidelines <https://github.com/python-telegram-bot/python-telegram-bot/blob/v13.x/.github/CONTRIBUTING.rst>`_ to get started. You can also help by `reporting bugs <https://github.com/python-telegram-bot/python-telegram-bot/issues/new>`_.
 
+========
 Donating
 ========
-Occasionally we are asked if we accept donations to support the development.
-While we appreciate the thought, maintaining PTB is our hobby, and we have almost no running costs for it. We therefore have nothing set up to accept donations.
-If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead.
+Occasionally we are asked if we accept donations to support the development. While we appreciate the thought, maintaining PTB is our hobby and we have almost no running costs for it. We therefore have nothing set up to accept donations. If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead.
 
+=======
 License
 =======
 
-You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 <https://www.gnu.org/licenses/lgpl-3.0.html>`_.
-Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be.
+You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 <https://www.gnu.org/licenses/lgpl-3.0.html>`_. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be.

README_RAW.rst

@@ -6,6 +6,12 @@
    :target: https://python-telegram-bot.org
    :alt: python-telegram-bot-raw Logo
 
+We have made you a wrapper you can't refuse
+
+We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us!
+
+*Stay tuned for library updates and new releases on our* `Telegram Channel <https://telegram.me/pythontelegrambotchannel>`_.
+
 .. image:: https://img.shields.io/pypi/v/python-telegram-bot-raw.svg
    :target: https://pypi.org/project/python-telegram-bot-raw/
    :alt: PyPi Package Version
@@ -14,7 +20,7 @@
    :target: https://pypi.org/project/python-telegram-bot-raw/
    :alt: Supported Python versions
 
-.. image:: https://img.shields.io/badge/Bot%20API-6.8-blue?logo=telegram
+.. image:: https://img.shields.io/badge/Bot%20API-6.1-blue?logo=telegram
    :target: https://core.telegram.org/bots/api-changelog
    :alt: Supported Bot API versions
 
@@ -23,188 +29,194 @@
    :alt: PyPi Package Monthly Download
 
 .. image:: https://readthedocs.org/projects/python-telegram-bot/badge/?version=stable
-   :target: https://docs.python-telegram-bot.org/
+   :target: https://python-telegram-bot.readthedocs.io/
    :alt: Documentation Status
 
 .. image:: https://img.shields.io/pypi/l/python-telegram-bot-raw.svg
    :target: https://www.gnu.org/licenses/lgpl-3.0.html
    :alt: LGPLv3 License
 
-.. image:: https://github.com/python-telegram-bot/python-telegram-bot/workflows/Unit%20Tests/badge.svg
+.. image:: https://github.com/python-telegram-bot/python-telegram-bot/workflows/GitHub%20Actions/badge.svg
    :target: https://github.com/python-telegram-bot/python-telegram-bot/
    :alt: Github Actions workflow
 
 .. image:: https://codecov.io/gh/python-telegram-bot/python-telegram-bot/branch/master/graph/badge.svg
-   :target: https://app.codecov.io/gh/python-telegram-bot/python-telegram-bot
+   :target: https://codecov.io/gh/python-telegram-bot/python-telegram-bot
    :alt: Code coverage
 
-.. image:: https://isitmaintained.com/badge/resolution/python-telegram-bot/python-telegram-bot.svg
-   :target: https://isitmaintained.com/project/python-telegram-bot/python-telegram-bot
+.. image:: http://isitmaintained.com/badge/resolution/python-telegram-bot/python-telegram-bot.svg
+   :target: http://isitmaintained.com/project/python-telegram-bot/python-telegram-bot
    :alt: Median time to resolve an issue
 
 .. image:: https://api.codacy.com/project/badge/Grade/99d901eaa09b44b4819aec05c330c968
-   :target: https://app.codacy.com/gh/python-telegram-bot/python-telegram-bot/dashboard
+   :target: https://www.codacy.com/app/python-telegram-bot/python-telegram-bot?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=python-telegram-bot/python-telegram-bot&amp;utm_campaign=Badge_Grade
    :alt: Code quality: Codacy
 
-.. image:: https://app.deepsource.com/gh/python-telegram-bot/python-telegram-bot.svg/?label=active+issues
-   :target: https://app.deepsource.com/gh/python-telegram-bot/python-telegram-bot/?ref=repository-badge
+.. image:: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot.svg/?label=active+issues
+   :target: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot/?ref=repository-badge
    :alt: Code quality: DeepSource
 
-.. image:: https://results.pre-commit.ci/badge/github/python-telegram-bot/python-telegram-bot/master.svg
-   :target: https://results.pre-commit.ci/latest/github/python-telegram-bot/python-telegram-bot/master
-   :alt: pre-commit.ci status
-
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
-   :alt: Code Style: Black
-
-.. image:: https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram
-   :target: https://t.me/pythontelegrambotchannel
-   :alt: Telegram Channel
 
 .. image:: https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram
    :target: https://telegram.me/pythontelegrambotgroup
    :alt: Telegram Group
 
-We have made you a wrapper you can't refuse
+=================
+Table of contents
+=================
 
-We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us!
+- `Introduction`_
 
-*Stay tuned for library updates and new releases on our* `Telegram Channel <https://telegram.me/pythontelegrambotchannel>`_.
+- `Telegram API support`_
 
+- `Installing`_
+
+- `Getting started`_
+
+  #. `Logging`_
+
+  #. `Documentation`_
+
+- `Getting help`_
+
+- `Contributing`_
+
+- `License`_
+
+============
 Introduction
 ============
 
-This library provides a pure Python, asynchronous interface for the
+This library provides a pure Python, lightweight interface for the
 `Telegram Bot API <https://core.telegram.org/bots/api>`_.
-It's compatible with Python versions **3.8+**.
+It's compatible with Python versions 3.7+. PTB-Raw might also work on `PyPy <http://pypy.org/>`_, though there have been a lot of issues before. Hence, PyPy is not officially supported.
 
-``python-telegram-bot-raw`` is part of the `python-telegram-bot <https://python-telegram-bot.org>`_ ecosystem and provides the pure API functionality extracted from PTB. It therefore does not have independent release schedules, changelogs or documentation.
+``python-telegram-bot-raw`` is part of the `python-telegram-bot <https://python-telegram-bot.org>`_ ecosystem and provides the pure API functionality extracted from PTB. It therefore does *not* have independent release schedules, changelogs or documentation. Please consult the PTB resources.
 
+----
 Note
 ----
 
 Installing both ``python-telegram-bot`` and ``python-telegram-bot-raw`` in conjunction will result in undesired side-effects, so only install *one* of both.
 
+====================
 Telegram API support
 ====================
 
-All types and methods of the Telegram Bot API **6.8** are supported.
+All types and methods of the Telegram Bot API **6.1** are supported.
 
+==========
 Installing
 ==========
 
-You can install or upgrade ``python-telegram-bot`` via
+You can install or upgrade python-telegram-bot-raw with:
 
 .. code:: shell
 
     $ pip install python-telegram-bot-raw --upgrade
 
-To install a pre-release, use the ``--pre`` `flag <https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-pre>`_ in addition.
-
-You can also install ``python-telegram-bot-raw`` from source, though this is usually not necessary.
+Or you can install from source with:
 
 .. code:: shell
 
-    $ git clone https://github.com/python-telegram-bot/python-telegram-bot
+    $ git clone https://github.com/python-telegram-bot/python-telegram-bot --recursive
     $ cd python-telegram-bot
     $ python setup-raw.py install
 
+In case you have a previously cloned local repository already, you should initialize the added urllib3 submodule before installing with:
+
+.. code:: shell
+
+    $ git submodule update --init --recursive
+
+----
 Note
 ----
 
-Installing the ``.tar.gz`` archive available on PyPi directly via ``pip`` will *not* work as expected, as ``pip`` does not recognize that it should use ``setup-raw.py`` instead of ``setup.py``.
-
-Verifying Releases
-------------------
-
-We sign all the releases with a GPG key.
-The signatures are uploaded to both the `GitHub releases page <https://github.com/python-telegram-bot/python-telegram-bot/releases>`_ and the `PyPI project <https://pypi.org/project/python-telegram-bot/>`_ and end with a suffix ``.asc``.
-Please find the public keys `here <https://github.com/python-telegram-bot/python-telegram-bot/tree/master/public_keys>`_.
-The keys are named in the format ``<first_version>-<last_version>.gpg`` or ``<first_version>-current.gpg`` if the key is currently being used for new releases.
-
-In addition, the GitHub release page also contains the sha1 hashes of the release files in the files with the suffix ``.sha1``.
-
-This allows you to verify that a release file that you downloaded was indeed provided by the ``python-telegram-bot`` team.
-
-Dependencies & Their Versions
------------------------------
-
-``python-telegram-bot`` tries to use as few 3rd party dependencies as possible.
-However, for some features using a 3rd party library is more sane than implementing the functionality again.
-As these features are *optional*, the corresponding 3rd party dependencies are not installed by default.
-Instead, they are listed as optional dependencies.
-This allows to avoid unnecessary dependency conflicts for users who don't need the optional features.
-
-The only required dependency is `httpx ~= 0.24.1 <https://www.python-httpx.org>`_ for
-``telegram.request.HTTPXRequest``, the default networking backend.
-
-``python-telegram-bot`` is most useful when used along with additional libraries.
-To minimize dependency conflicts, we try to be liberal in terms of version requirements on the (optional) dependencies.
-On the other hand, we have to ensure stability of ``python-telegram-bot``, which is why we do apply version bounds.
-If you encounter dependency conflicts due to these bounds, feel free to reach out.
+Installing the `.tar.gz` archive available on PyPi directly via `pip` will *not* work as expected, as `pip` does not recognize that it should use `setup-raw.py` instead of `setup.py`.
 
+---------------------
 Optional Dependencies
-#####################
+---------------------
 
 PTB can be installed with optional dependencies:
 
-* ``pip install "python-telegram-bot-raw[passport]"`` installs the `cryptography>=39.0.1 <https://cryptography.io/en/stable>`_ library. Use this, if you want to use Telegram Passport related functionality.
-* ``pip install "python-telegram-bot-raw[socks]"`` installs `httpx[socks] <https://www.python-httpx.org/#dependencies>`_. Use this, if you want to work behind a Socks5 server.
-* ``pip install "python-telegram-bot-raw[http2]"`` installs `httpx[http2] <https://www.python-httpx.org/#dependencies>`_. Use this, if you want to use HTTP/2.
+* ``pip install python-telegram-bot-raw[passport]`` installs the `cryptography <https://cryptography.io>`_ library. Use this, if you want to use Telegram Passport related functionality.
+* ``pip install python-telegram-bot-raw[ujson]`` installs the `ujson <https://pypi.org/project/ujson/>`_ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard `json <https://docs.python.org/3/library/json.html>`_ library.
 
-To install multiple optional dependencies, separate them by commas, e.g. ``pip install "python-telegram-bot-raw[passport,socks]"``.
+===============
+Getting started
+===============
 
-Additionally, the shortcut ``pip install "python-telegram-bot-raw[all]"`` installs all optional dependencies.
+Our Wiki contains an `Introduction to the API <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Introduction-to-the-API>`_. Other references are:
 
-Quick Start
-===========
+- the `Telegram API documentation <https://core.telegram.org/bots/api>`_
+- the `python-telegram-bot documentation <https://python-telegram-bot.readthedocs.io/>`_
 
-Our Wiki contains an `Introduction to the API <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Introduction-to-the-API>`_ explaining how the pure Bot API can be accessed via ``python-telegram-bot``.
+-------
+Logging
+-------
 
-Resources
-=========
+This library uses the ``logging`` module. To set up logging to standard output, put:
 
-- The `package documentation <https://docs.python-telegram-bot.org/>`_ is the technical reference for ``python-telegram-bot``.
-  It contains descriptions of all available classes, modules, methods and arguments as well as the `changelog <https://docs.python-telegram-bot.org/changelog.html>`_.
-- The `wiki <https://github.com/python-telegram-bot/python-telegram-bot/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 <https://docs.python-telegram-bot.org/examples.html>`_ 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 <https://core.telegram.org/bots/api>`_ is of course always worth a read.
+.. code:: python
 
+    import logging
+    logging.basicConfig(level=logging.DEBUG,
+                        format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+
+at the beginning of your script.
+
+You can also use logs in your application by calling ``logging.getLogger()`` and setting the log level you want:
+
+.. code:: python
+
+    logger = logging.getLogger()
+    logger.setLevel(logging.INFO)
+
+If you want DEBUG logs instead:
+
+.. code:: python
+
+    logger.setLevel(logging.DEBUG)
+
+
+=============
+Documentation
+=============
+
+``python-telegram-bot``'s documentation lives at `readthedocs.io <https://python-telegram-bot.readthedocs.io/>`_, which
+includes the relevant documentation for ``python-telegram-bot-raw``.
+
+============
 Getting help
 ============
 
-If the resources mentioned above don't answer your questions or simply overwhelm you, there are several ways of getting help.
+You can get help in several ways:
 
-1. We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us! Asking a question here is often the quickest way to get a pointer in the right direction.
+1. We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us!
 
-2. Ask questions by opening `a discussion <https://github.com/python-telegram-bot/python-telegram-bot/discussions/new>`_.
+2. Report bugs, request new features or ask questions by `creating an issue <https://github.com/python-telegram-bot/python-telegram-bot/issues/new/choose>`_ or `a discussion <https://github.com/python-telegram-bot/python-telegram-bot/discussions/new>`_.
 
-3. You can even ask for help on Stack Overflow using the `python-telegram-bot tag <https://stackoverflow.com/questions/tagged/python-telegram-bot>`_.
+3. Our `Wiki pages <https://github.com/python-telegram-bot/python-telegram-bot/wiki/>`_ offer a growing amount of resources.
 
-Concurrency
-===========
-
-Since v20.0, ``python-telegram-bot`` is built on top of Pythons ``asyncio`` module.
-Because ``asyncio`` is in general single-threaded, ``python-telegram-bot`` does currently not aim to be thread-safe.
+4. You can even ask for help on Stack Overflow using the `python-telegram-bot tag <https://stackoverflow.com/questions/tagged/python-telegram-bot>`_.
 
+============
 Contributing
 ============
 
-Contributions of all sizes are welcome.
-Please review our `contribution guidelines <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/.github/CONTRIBUTING.rst>`_ to get started.
-You can also help by `reporting bugs or feature requests <https://github.com/python-telegram-bot/python-telegram-bot/issues/new/choose>`_.
+Contributions of all sizes are welcome. Please review our `contribution guidelines <https://github.com/python-telegram-bot/python-telegram-bot/blob/v13.x/.github/CONTRIBUTING.rst>`_ to get started. You can also help by `reporting bugs <https://github.com/python-telegram-bot/python-telegram-bot/issues/new>`_.
 
+========
 Donating
 ========
-Occasionally we are asked if we accept donations to support the development.
-While we appreciate the thought, maintaining PTB is our hobby, and we have almost no running costs for it. We therefore have nothing set up to accept donations.
-If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead.
+Occasionally we are asked if we accept donations to support the development. While we appreciate the thought, maintaining PTB is our hobby and we have almost no running costs for it. We therefore have nothing set up to accept donations. If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead.
 
+=======
 License
 =======
 
-You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 <https://www.gnu.org/licenses/lgpl-3.0.html>`_.
-Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be.
+You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 <https://www.gnu.org/licenses/lgpl-3.0.html>`_. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be.

docs/Makefile

@@ -15,7 +15,7 @@ endif
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -j auto
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 
@@ -56,8 +56,6 @@ html:
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
-rebuild: clean html
-
 dirhtml:
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 	@echo

docs/auxil/admonition_inserter.py

@@ -1,594 +0,0 @@
-#
-#  A library that provides a Python interface to the Telegram Bot API
-#  Copyright (C) 2015-2023
-#  Leandro Toledo de Souza <devs@python-telegram-bot.org>
-#
-#  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/].
-import collections.abc
-import inspect
-import re
-import typing
-from collections import defaultdict
-from typing import Any, Iterator, Union
-
-import telegram
-import telegram.ext
-
-
-def _iter_own_public_methods(cls: type) -> Iterator[tuple[str, type]]:
-    """Iterates over methods of a class that are not protected/private,
-    not camelCase and not inherited from the parent class.
-
-    Returns pairs of method names and methods.
-
-    This function is defined outside the class because it is used to create class constants.
-    """
-    return (
-        m
-        for m in inspect.getmembers(cls, predicate=inspect.isfunction)  # not .ismethod
-        if not m[0].startswith("_")
-        and m[0].islower()  # to avoid camelCase methods
-        and m[0] in cls.__dict__  # method is not inherited from parent class
-    )
-
-
-class AdmonitionInserter:
-    """Class for inserting admonitions into docs of Telegram classes."""
-
-    CLASS_ADMONITION_TYPES = ("use_in", "available_in", "returned_in")
-    METHOD_ADMONITION_TYPES = ("shortcuts",)
-    ALL_ADMONITION_TYPES = CLASS_ADMONITION_TYPES + METHOD_ADMONITION_TYPES
-
-    FORWARD_REF_PATTERN = re.compile(r"^ForwardRef\('(?P<class_name>\w+)'\)$")
-    """ A pattern to find a class name in a ForwardRef typing annotation.
-    Class name (in a named group) is surrounded by parentheses and single quotes.
-    Note that since we're analyzing argument by argument, the pattern can be strict, with
-    start and end markers.
-    """
-
-    FORWARD_REF_SKIP_PATTERN = re.compile(r"^ForwardRef\('DefaultValue\[\w+]'\)$")
-    """A pattern that will be used to skip known ForwardRef's that need not be resolved
-    to a Telegram class, e.g.:
-    ForwardRef('DefaultValue[None]')
-    ForwardRef('DefaultValue[DVValueType]')
-    """
-
-    METHOD_NAMES_FOR_BOT_AND_APPBUILDER: dict[type, str] = {
-        cls: tuple(m[0] for m in _iter_own_public_methods(cls))  # m[0] means we take only names
-        for cls in (telegram.Bot, telegram.ext.ApplicationBuilder)
-    }
-    """A dictionary mapping Bot and ApplicationBuilder classes to their relevant methods that will
-    be mentioned in 'Returned in' and 'Use in' admonitions in other classes' docstrings.
-    Methods must be public, not aliases, not inherited from TelegramObject.
-    """
-
-    def __init__(self):
-        self.admonitions: dict[str, dict[Union[type, collections.abc.Callable], str]] = {
-            # dynamically determine which method to use to create a sub-dictionary
-            admonition_type: getattr(self, f"_create_{admonition_type}")()
-            for admonition_type in self.ALL_ADMONITION_TYPES
-        }
-        """Dictionary with admonitions. Contains sub-dictionaries, one per admonition type.
-        Each sub-dictionary matches bot methods (for "Shortcuts") or telegram classes (for other
-        admonition types) to texts of admonitions, e.g.:
-        ```
-        {
-        "use_in": {<class 'telegram._chatinvitelink.ChatInviteLink'>:
-        <"Use in" admonition for ChatInviteLink>, ...},
-        "available_in": {<class 'telegram._chatinvitelink.ChatInviteLink'>:
-        <"Available in" admonition">, ...},
-        "returned_in": {...}
-        }
-        ```
-        """
-
-    def insert_admonitions(
-        self,
-        obj: Union[type, collections.abc.Callable],
-        docstring_lines: list[str],
-    ):
-        """Inserts admonitions into docstring lines for a given class or method.
-
-        **Modifies lines in place**.
-        """
-        # A better way would be to copy the lines and return them, but that will not work with
-        # docs.auxil.sphinx_hooks.autodoc_process_docstring()
-
-        for admonition_type in self.ALL_ADMONITION_TYPES:
-            # If there is no admonition of the given type for the given class or method,
-            # continue to the next admonition type, maybe the class/method is listed there.
-            if obj not in self.admonitions[admonition_type]:
-                continue
-
-            insert_idx = self._find_insert_pos_for_admonition(docstring_lines)
-            admonition_lines = self.admonitions[admonition_type][obj].splitlines()
-
-            for idx in range(insert_idx, insert_idx + len(admonition_lines)):
-                docstring_lines.insert(idx, admonition_lines[idx - insert_idx])
-
-    def _create_available_in(self) -> dict[type, str]:
-        """Creates a dictionary with 'Available in' admonitions for classes that are available
-        in attributes of other classes.
-        """
-
-        # Generate a mapping of classes to ReST links to attributes in other classes that
-        # correspond to instances of a given class
-        # i.e. {telegram._files.sticker.Sticker: {":attr:`telegram.Message.sticker`", ...}}
-        attrs_for_class = defaultdict(set)
-
-        # The following regex is supposed to capture a class name in a line like this:
-        # media (:obj:`str` | :class:`telegram.InputFile`): Audio file to send.
-        #
-        # Note that even if such typing description spans over multiple lines but each line ends
-        # with a backslash (otherwise Sphinx will throw an error)
-        # (e.g. EncryptedPassportElement.data), then Sphinx will combine these lines into a single
-        # line automatically, and it will contain no backslash (only some extra many whitespaces
-        # from the indentation).
-
-        attr_docstr_pattern = re.compile(
-            r"^\s*(?P<attr_name>[a-z_]+)"  # Any number of spaces, named group for attribute
-            r"\s?\("  # Optional whitespace, opening parenthesis
-            r".*"  # Any number of characters (that could denote a built-in type)
-            r":class:`.+`"  # Marker of a classref, class name in backticks
-            r".*\):"  # Any number of characters, closing parenthesis, colon.
-            # The ^ colon above along with parenthesis is important because it makes sure that
-            # the class is mentioned in the attribute description, not in free text.
-            r".*$",  # Any number of characters, end of string (end of line)
-            re.VERBOSE,
-        )
-
-        # for properties: there is no attr name in docstring.  Just check if there's a class name.
-        prop_docstring_pattern = re.compile(r":class:`.+`.*:")
-
-        # pattern for iterating over potentially many class names in docstring for one attribute.
-        # Tilde is optional (sometimes it is in the docstring, sometimes not).
-        single_class_name_pattern = re.compile(r":class:`~?(?P<class_name>[\w.]*)`")
-
-        classes_to_inspect = inspect.getmembers(telegram, inspect.isclass) + inspect.getmembers(
-            telegram.ext, inspect.isclass
-        )
-
-        for class_name, inspected_class in classes_to_inspect:
-            # We need to make "<class 'telegram._files.sticker.StickerSet'>" into
-            # "telegram.StickerSet" because that's the way the classes are mentioned in
-            # docstrings.
-            name_of_inspected_class_in_docstr = self._generate_class_name_for_link(inspected_class)
-
-            # Parsing part of the docstring with attributes (parsing of properties follows later)
-            docstring_lines = inspect.getdoc(inspected_class).splitlines()
-            lines_with_attrs = []
-            for idx, line in enumerate(docstring_lines):
-                if line.strip() == "Attributes:":
-                    lines_with_attrs = docstring_lines[idx + 1 :]
-                    break
-
-            for line in lines_with_attrs:
-                if not (line_match := attr_docstr_pattern.match(line)):
-                    continue
-
-                target_attr = line_match.group("attr_name")
-                # a typing description of one attribute can contain multiple classes
-                for match in single_class_name_pattern.finditer(line):
-                    name_of_class_in_attr = match.group("class_name")
-
-                    # Writing to dictionary: matching the class found in the docstring
-                    # and its subclasses to the attribute of the class being inspected.
-                    # The class in the attribute docstring (or its subclass) is the key,
-                    # ReST link to attribute of the class currently being inspected is the value.
-                    try:
-                        self._resolve_arg_and_add_link(
-                            arg=name_of_class_in_attr,
-                            dict_of_methods_for_class=attrs_for_class,
-                            link=f":attr:`{name_of_inspected_class_in_docstr}.{target_attr}`",
-                        )
-                    except NotImplementedError as e:
-                        raise NotImplementedError(
-                            f"Error generating Sphinx 'Available in' admonition "
-                            f"(admonition_inserter.py). Class {name_of_class_in_attr} present in "
-                            f"attribute {target_attr} of class {name_of_inspected_class_in_docstr}"
-                            f" could not be resolved. {str(e)}"
-                        )
-
-            # Properties need to be parsed separately because they act like attributes but not
-            # listed as attributes.
-            properties = inspect.getmembers(inspected_class, lambda o: isinstance(o, property))
-            for prop_name, _ in properties:
-                # Make sure this property is really defined in the class being inspected.
-                # A property can be inherited from a parent class, then a link to it will not work.
-                if prop_name not in inspected_class.__dict__:
-                    continue
-
-                # 1. Can't use typing.get_type_hints because double-quoted type hints
-                #    (like "Application") will throw a NameError
-                # 2. Can't use inspect.signature because return annotations of properties can be
-                #    hard to parse (like "(self) -> BD").
-                # 3. fget is used to access the actual function under the property wrapper
-                docstring = inspect.getdoc(getattr(inspected_class, prop_name).fget)
-                if docstring is None:
-                    continue
-
-                first_line = docstring.splitlines()[0]
-                if not prop_docstring_pattern.match(first_line):
-                    continue
-
-                for match in single_class_name_pattern.finditer(first_line):
-                    name_of_class_in_prop = match.group("class_name")
-
-                    # Writing to dictionary: matching the class found in the docstring and its
-                    # subclasses to the property of the class being inspected.
-                    # The class in the property docstring (or its subclass) is the key,
-                    # ReST link to property of the class currently being inspected is the value.
-                    try:
-                        self._resolve_arg_and_add_link(
-                            arg=name_of_class_in_prop,
-                            dict_of_methods_for_class=attrs_for_class,
-                            link=f":attr:`{name_of_inspected_class_in_docstr}.{prop_name}`",
-                        )
-                    except NotImplementedError as e:
-                        raise NotImplementedError(
-                            f"Error generating Sphinx 'Available in' admonition "
-                            f"(admonition_inserter.py). Class {name_of_class_in_prop} present in "
-                            f"property {prop_name} of class {name_of_inspected_class_in_docstr}"
-                            f" could not be resolved. {str(e)}"
-                        )
-
-        return self._generate_admonitions(attrs_for_class, admonition_type="available_in")
-
-    def _create_returned_in(self) -> dict[type, str]:
-        """Creates a dictionary with 'Returned in' admonitions for classes that are returned
-        in Bot's and ApplicationBuilder's methods.
-        """
-
-        # Generate a mapping of classes to ReST links to Bot methods which return it,
-        # i.e. {<class 'telegram._message.Message'>: {:meth:`telegram.Bot.send_message`, ...}}
-        methods_for_class = defaultdict(set)
-
-        for cls, method_names in self.METHOD_NAMES_FOR_BOT_AND_APPBUILDER.items():
-            for method_name in method_names:
-                sig = inspect.signature(getattr(cls, method_name))
-                ret_annot = sig.return_annotation
-
-                method_link = self._generate_link_to_method(method_name, cls)
-
-                try:
-                    self._resolve_arg_and_add_link(
-                        arg=ret_annot,
-                        dict_of_methods_for_class=methods_for_class,
-                        link=method_link,
-                    )
-                except NotImplementedError as e:
-                    raise NotImplementedError(
-                        f"Error generating Sphinx 'Returned in' admonition "
-                        f"(admonition_inserter.py). {cls}, method {method_name}. "
-                        f"Couldn't resolve type hint in return annotation {ret_annot}. {str(e)}"
-                    )
-
-        return self._generate_admonitions(methods_for_class, admonition_type="returned_in")
-
-    def _create_shortcuts(self) -> dict[collections.abc.Callable, str]:
-        """Creates a dictionary with 'Shortcuts' admonitions for Bot methods that
-        have shortcuts in other classes.
-        """
-
-        # pattern for looking for calls to Bot methods only
-        bot_method_pattern = re.compile(
-            r"""\s*  # any number of whitespaces
-            (?<=return\sawait\sself\.get_bot\(\)\.)  # lookbehind
-            \w+  # the method name we are looking for, letters/underscores
-            (?=\() # lookahead: opening bracket before the args of the method start
-            """,
-            re.VERBOSE,
-        )
-
-        # Generate a mapping of methods of classes to links to Bot methods which they are shortcuts
-        # for, i.e. {<function Bot.send_voice at ...>: {:meth:`telegram.User.send_voice`, ...}
-        shortcuts_for_bot_method = defaultdict(set)
-
-        # inspect methods of all telegram classes for return statements that indicate
-        # that this given method is a shortcut for a Bot method
-        for class_name, cls in inspect.getmembers(telegram, predicate=inspect.isclass):
-            # no need to inspect Bot's own methods, as Bot can't have shortcuts in Bot
-            if cls is telegram.Bot:
-                continue
-
-            for method_name, method in _iter_own_public_methods(cls):
-                # .getsourcelines() returns a tuple. Item [1] is an int
-                for line in inspect.getsourcelines(method)[0]:
-                    if not (bot_method_match := bot_method_pattern.search(line)):
-                        continue
-
-                    bot_method = getattr(telegram.Bot, bot_method_match.group())
-
-                    link_to_shortcut_method = self._generate_link_to_method(method_name, cls)
-
-                    shortcuts_for_bot_method[bot_method].add(link_to_shortcut_method)
-
-        return self._generate_admonitions(shortcuts_for_bot_method, admonition_type="shortcuts")
-
-    def _create_use_in(self) -> dict[type, str]:
-        """Creates a dictionary with 'Use in' admonitions for classes whose instances are
-        accepted as arguments for Bot's and ApplicationBuilder's methods.
-        """
-
-        # Generate a mapping of classes to links to Bot methods which accept them as arguments,
-        # i.e. {<class 'telegram._inline.inlinequeryresult.InlineQueryResult'>:
-        # {:meth:`telegram.Bot.answer_inline_query`, ...}}
-        methods_for_class = defaultdict(set)
-
-        for cls, method_names in self.METHOD_NAMES_FOR_BOT_AND_APPBUILDER.items():
-            for method_name in method_names:
-                method_link = self._generate_link_to_method(method_name, cls)
-
-                sig = inspect.signature(getattr(cls, method_name))
-                parameters = sig.parameters
-
-                for param in parameters.values():
-                    try:
-                        self._resolve_arg_and_add_link(
-                            arg=param.annotation,
-                            dict_of_methods_for_class=methods_for_class,
-                            link=method_link,
-                        )
-                    except NotImplementedError as e:
-                        raise NotImplementedError(
-                            f"Error generating Sphinx 'Use in' admonition "
-                            f"(admonition_inserter.py). {cls}, method {method_name}, parameter "
-                            f"{param}: Couldn't resolve type hint {param.annotation}. {str(e)}"
-                        )
-
-        return self._generate_admonitions(methods_for_class, admonition_type="use_in")
-
-    @staticmethod
-    def _find_insert_pos_for_admonition(lines: list[str]) -> int:
-        """Finds the correct position to insert the class admonition and returns the index.
-
-        The admonition will be insert above "See also", "Examples:", version added/changed notes
-        and args, whatever comes first.
-
-        If no key phrases are found, the admonition will be inserted at the very end.
-        """
-        for idx, value in list(enumerate(lines)):
-            if (
-                value.startswith(".. seealso:")
-                # The docstring contains heading "Examples:", but Sphinx will have it converted
-                # to ".. admonition: Examples":
-                or value.startswith(".. admonition:: Examples")
-                or value.startswith(".. version")
-                # The space after ":param" is important because docstring can contain ":paramref:"
-                # in its plain text in the beginning of a line (e.g. ExtBot):
-                or value.startswith(":param ")
-                # some classes (like "Credentials") have no params, so insert before attrs:
-                or value.startswith(".. attribute::")
-            ):
-                return idx
-        return len(lines) - 1
-
-    def _generate_admonitions(
-        self,
-        attrs_or_methods_for_class: dict[type, set[str]],
-        admonition_type: str,
-    ) -> dict[type, str]:
-        """Generates admonitions of a given type.
-        Takes a dictionary of classes matched to ReST links to methods or attributes, e.g.:
-
-        ```
-        {<class 'telegram._files.sticker.StickerSet'>:
-        [":meth: `telegram.Bot.get_sticker_set`", ...]}.
-        ```
-
-        Returns a dictionary of classes matched to full admonitions, e.g.
-        for `admonition_type` "returned_in" (note that title and CSS class are generated
-        automatically):
-
-        ```
-        {<class 'telegram._files.sticker.StickerSet'>:
-        ".. admonition:: Returned in:
-            :class: returned-in
-
-            :meth: `telegram.Bot.get_sticker_set`"}.
-        ```
-        """
-
-        if admonition_type not in self.ALL_ADMONITION_TYPES:
-            raise TypeError(f"Admonition type {admonition_type} not supported.")
-
-        admonition_for_class = {}
-
-        for cls, attrs in attrs_or_methods_for_class.items():
-            if cls is telegram.ext.ApplicationBuilder:
-                # ApplicationBuilder is only used in and returned from its own methods,
-                # so its page needs no admonitions.
-                continue
-
-            attrs = sorted(attrs)
-
-            # e.g. for admonition type "use_in" the title will be "Use in" and CSS class "use-in".
-            admonition = f"""
-
-.. admonition:: {admonition_type.title().replace("_", " ")}
-    :class: {admonition_type.replace("_", "-")}
-    """
-            if len(attrs) > 1:
-                for target_attr in attrs:
-                    admonition += "\n    * " + target_attr
-            else:
-                admonition += f"\n    {attrs[0]}"
-
-            admonition += "\n    "  # otherwise an unexpected unindent warning will be issued
-            admonition_for_class[cls] = admonition
-
-        return admonition_for_class
-
-    @staticmethod
-    def _generate_class_name_for_link(cls: type) -> str:
-        """Generates class name that can be used in a ReST link."""
-
-        # Check for potential presence of ".ext.", we will need to keep it.
-        ext = ".ext" if ".ext." in str(cls) else ""
-        return f"telegram{ext}.{cls.__name__}"
-
-    def _generate_link_to_method(self, method_name: str, cls: type) -> str:
-        """Generates a ReST link to a method of a telegram class."""
-
-        return f":meth:`{self._generate_class_name_for_link(cls)}.{method_name}`"
-
-    @staticmethod
-    def _iter_subclasses(cls: type) -> Iterator:
-        return (
-            # exclude private classes
-            c
-            for c in cls.__subclasses__()
-            if not str(c).split(".")[-1].startswith("_")
-        )
-
-    def _resolve_arg_and_add_link(
-        self,
-        arg: Any,
-        dict_of_methods_for_class: defaultdict,
-        link: str,
-    ) -> None:
-        """A helper method. Tries to resolve the arg into a valid class. In case of success,
-        adds the link (to a method, attribute, or property) for that class' and its subclasses'
-        sets of links in the dictionary of admonitions.
-
-        **Modifies dictionary in place.**
-        """
-        for cls in self._resolve_arg(arg):
-            # When trying to resolve an argument from args or return annotation,
-            # the method _resolve_arg returns None if nothing could be resolved.
-            # Also, if class was resolved correctly, "telegram" will definitely be in its str().
-            if cls is None or "telegram" not in str(cls):
-                continue
-
-            dict_of_methods_for_class[cls].add(link)
-
-            for subclass in self._iter_subclasses(cls):
-                dict_of_methods_for_class[subclass].add(link)
-
-    def _resolve_arg(self, arg: Any) -> Iterator[Union[type, None]]:
-        """Analyzes an argument of a method and recursively yields classes that the argument
-        or its sub-arguments (in cases like Union[...]) belong to, if they can be resolved to
-        telegram or telegram.ext classes.
-
-        Raises `NotImplementedError`.
-        """
-
-        origin = typing.get_origin(arg)
-
-        if (
-            origin in (collections.abc.Callable, typing.IO)
-            or arg is None
-            # no other check available (by type or origin) for these:
-            or str(type(arg)) in ("<class 'typing._SpecialForm'>", "<class 'ellipsis'>")
-        ):
-            pass
-
-        # RECURSIVE CALLS
-        # for cases like Union[Sequence....
-        elif origin in (
-            Union,
-            collections.abc.Coroutine,
-            collections.abc.Sequence,
-        ):
-            for sub_arg in typing.get_args(arg):
-                yield from self._resolve_arg(sub_arg)
-
-        elif isinstance(arg, typing.TypeVar):
-            # gets access to the "bound=..." parameter
-            yield from self._resolve_arg(arg.__bound__)
-        # END RECURSIVE CALLS
-
-        elif isinstance(arg, typing.ForwardRef):
-            m = self.FORWARD_REF_PATTERN.match(str(arg))
-            # We're sure it's a ForwardRef, so, unless it belongs to known exceptions,
-            # the class must be resolved.
-            # If it isn't resolved, we'll have the program throw an exception to be sure.
-            try:
-                cls = self._resolve_class(m.group("class_name"))
-            except AttributeError:
-                # skip known ForwardRef's that need not be resolved to a Telegram class
-                if self.FORWARD_REF_SKIP_PATTERN.match(str(arg)):
-                    pass
-                else:
-                    raise NotImplementedError(f"Could not process ForwardRef: {arg}")
-            else:
-                yield cls
-
-        # For custom generics like telegram.ext._application.Application[~BT, ~CCT, ~UD...].
-        # This must come before the check for isinstance(type) because GenericAlias can also be
-        # recognized as type if it belongs to <class 'types.GenericAlias'>.
-        elif str(type(arg)) in (
-            "<class 'typing._GenericAlias'>",
-            "<class 'types.GenericAlias'>",
-            "<class 'typing._LiteralGenericAlias'>",
-        ):
-            if "telegram" in str(arg):
-                # get_origin() of telegram.ext._application.Application[~BT, ~CCT, ~UD...]
-                # will produce <class 'telegram.ext._application.Application'>
-                yield origin
-
-        elif isinstance(arg, type):
-            if "telegram" in str(arg):
-                yield arg
-
-        # For some reason "InlineQueryResult", "InputMedia" & some others are currently not
-        # recognized as ForwardRefs and are identified as plain strings.
-        elif isinstance(arg, str):
-            # args like "ApplicationBuilder[BT, CCT, UD, CD, BD, JQ]" can be recognized as strings.
-            # Remove whatever is in the square brackets because it doesn't need to be parsed.
-            arg = re.sub(r"\[.+]", "", arg)
-
-            cls = self._resolve_class(arg)
-            # Here we don't want an exception to be thrown since we're not sure it's ForwardRef
-            if cls is not None:
-                yield cls
-
-        else:
-            raise NotImplementedError(
-                f"Cannot process argument {arg} of type {type(arg)} (origin {origin})"
-            )
-
-    @staticmethod
-    def _resolve_class(name: str) -> Union[type, None]:
-        """The keys in the admonitions dictionary are not strings like "telegram.StickerSet"
-        but classes like <class 'telegram._files.sticker.StickerSet'>.
-
-        This method attempts to resolve a PTB class from a name that does or does not
-        contain the word 'telegram', e.g.
-        <class 'telegram._files.sticker.StickerSet'> from "telegram.StickerSet" or "StickerSet".
-
-        Returns a class on success, :obj:`None` if nothing could be resolved.
-        """
-
-        for option in (
-            name,
-            f"telegram.{name}",
-            f"telegram.ext.{name}",
-            f"telegram.ext.filters.{name}",
-        ):
-            try:
-                return eval(option)
-            # NameError will be raised if trying to eval just name and it doesn't work, e.g.
-            # "Name 'ApplicationBuilder' is not defined".
-            # AttributeError will be raised if trying to e.g. eval f"telegram.{name}" when the
-            # class denoted by `name` actually belongs to `telegram.ext`:
-            # "module 'telegram' has no attribute 'ApplicationBuilder'".
-            # If neither option works, this is not a PTB class.
-            except (NameError, AttributeError):
-                continue
-
-
-if __name__ == "__main__":
-    # just try instantiating for debugging purposes
-    AdmonitionInserter()

docs/auxil/kwargs_insertion.py

@@ -1,79 +0,0 @@
-#
-#  A library that provides a Python interface to the Telegram Bot API
-#  Copyright (C) 2015-2023
-#  Leandro Toledo de Souza <devs@python-telegram-bot.org>
-#
-#  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/].
-import inspect
-
-keyword_args = [
-    ":keyword _sphinx_paramlinks_telegram.Bot.{method}.read_timeout: Value to pass to "
-    ":paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to {read_timeout}.",
-    ":kwtype _sphinx_paramlinks_telegram.Bot.{method}.read_timeout: {read_timeout_type}, optional",
-    ":keyword _sphinx_paramlinks_telegram.Bot.{method}.write_timeout: Value to pass to "
-    ":paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to {write_timeout}.",
-    ":kwtype _sphinx_paramlinks_telegram.Bot.{method}.write_timeout: :obj:`float` | :obj:`None`, "
-    "optional",
-    ":keyword _sphinx_paramlinks_telegram.Bot.{method}.connect_timeout: Value to pass to "
-    ":paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to "
-    ":attr:`~telegram.request.BaseRequest.DEFAULT_NONE`.",
-    ":kwtype _sphinx_paramlinks_telegram.Bot.{method}.connect_timeout: :obj:`float` | "
-    ":obj:`None`, optional",
-    ":keyword _sphinx_paramlinks_telegram.Bot.{method}.pool_timeout: Value to pass to "
-    ":paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to "
-    ":attr:`~telegram.request.BaseRequest.DEFAULT_NONE`.",
-    ":kwtype _sphinx_paramlinks_telegram.Bot.{method}.pool_timeout: :obj:`float` | :obj:`None`, "
-    "optional",
-    ":keyword _sphinx_paramlinks_telegram.Bot.{method}.api_kwargs: Arbitrary keyword arguments "
-    "to be passed to the Telegram API.",
-    ":kwtype _sphinx_paramlinks_telegram.Bot.{method}.api_kwargs: :obj:`dict`, optional",
-    "",
-]
-write_timeout_sub = [":attr:`~telegram.request.BaseRequest.DEFAULT_NONE`", "``20``"]
-read_timeout_sub = [
-    ":attr:`~telegram.request.BaseRequest.DEFAULT_NONE`",
-    "``2``. :paramref:`timeout` will be added to this value",
-]
-read_timeout_type = [":obj:`float` | :obj:`None`", ":obj:`float`"]
-
-
-def find_insert_pos_for_kwargs(lines: list[str]) -> int:
-    """Finds the correct position to insert the keyword arguments and returns the index."""
-    for idx, value in reversed(list(enumerate(lines))):  # reversed since :returns: is at the end
-        if value.startswith(":returns:"):
-            return idx
-    else:
-        return False
-
-
-def is_write_timeout_20(obj: object) -> int:
-    """inspects the default value of write_timeout parameter of the bot method."""
-    sig = inspect.signature(obj)
-    return 1 if (sig.parameters["write_timeout"].default == 20) else 0
-
-
-def check_timeout_and_api_kwargs_presence(obj: object) -> int:
-    """Checks if the method has timeout and api_kwargs keyword only parameters."""
-    sig = inspect.signature(obj)
-    params_to_check = (
-        "read_timeout",
-        "write_timeout",
-        "connect_timeout",
-        "pool_timeout",
-        "api_kwargs",
-    )
-    return all(
-        param in sig.parameters and sig.parameters[param].kind == inspect.Parameter.KEYWORD_ONLY
-        for param in params_to_check
-    )

docs/auxil/link_code.py

@@ -1,77 +0,0 @@
-#
-#  A library that provides a Python interface to the Telegram Bot API
-#  Copyright (C) 2015-2023
-#  Leandro Toledo de Souza <devs@python-telegram-bot.org>
-#
-#  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/].
-"""Functionality in this file is used for getting the [source] links on the classes, methods etc
-to link to the correct files & lines on github. Can be simplified once
-https://github.com/sphinx-doc/sphinx/issues/1556 is closed
-"""
-import subprocess
-
-from sphinx.util import logging
-
-# get the sphinx(!) logger
-# Makes sure logs render in red and also plays nicely with e.g. the `nitpicky` option.
-sphinx_logger = logging.getLogger(__name__)
-
-
-# must be a module-level variable so that it can be written to by the `autodoc-process-docstring`
-# event handler in `sphinx_hooks.py`
-LINE_NUMBERS = {}
-
-
-def _git_branch() -> str:
-    """Get's the current git sha if available or fall back to `master`"""
-    try:
-        output = subprocess.check_output(  # skipcq: BAN-B607
-            ["git", "describe", "--tags", "--always"], stderr=subprocess.STDOUT
-        )
-        return output.decode().strip()
-    except Exception as exc:
-        sphinx_logger.exception(
-            "Failed to get a description of the current commit. Falling back to `master`.",
-            exc_info=exc,
-        )
-        return "master"
-
-
-git_branch = _git_branch()
-base_url = "https://github.com/python-telegram-bot/python-telegram-bot/blob/"
-
-
-def linkcode_resolve(_, info):
-    """See www.sphinx-doc.org/en/master/usage/extensions/linkcode.html"""
-    combined = ".".join((info["module"], info["fullname"]))
-    # special casing for ExtBot which is due to the special structure of extbot.rst
-    combined = combined.replace("ExtBot.ExtBot", "ExtBot")
-
-    line_info = LINE_NUMBERS.get(combined)
-
-    if not line_info:
-        # Try the __init__
-        line_info = LINE_NUMBERS.get(f"{combined.rsplit('.', 1)[0]}.__init__")
-    if not line_info:
-        # Try the class
-        line_info = LINE_NUMBERS.get(f"{combined.rsplit('.', 1)[0]}")
-    if not line_info:
-        # Try the module
-        line_info = LINE_NUMBERS.get(info["module"])
-
-    if not line_info:
-        return
-
-    file, start_line, end_line = line_info
-    return f"{base_url}{git_branch}/{file}#L{start_line}-L{end_line}"

docs/auxil/sphinx_hooks.py

@@ -1,211 +0,0 @@
-#
-#  A library that provides a Python interface to the Telegram Bot API
-#  Copyright (C) 2015-2023
-#  Leandro Toledo de Souza <devs@python-telegram-bot.org>
-#
-#  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/].
-import collections.abc
-import inspect
-import re
-import typing
-from pathlib import Path
-
-from sphinx.application import Sphinx
-
-import telegram
-import telegram.ext
-from docs.auxil.admonition_inserter import AdmonitionInserter
-from docs.auxil.kwargs_insertion import (
-    check_timeout_and_api_kwargs_presence,
-    find_insert_pos_for_kwargs,
-    is_write_timeout_20,
-    keyword_args,
-    read_timeout_sub,
-    read_timeout_type,
-    write_timeout_sub,
-)
-from docs.auxil.link_code import LINE_NUMBERS
-
-ADMONITION_INSERTER = AdmonitionInserter()
-
-# Some base classes are implementation detail
-# We want to instead show *their* base class
-PRIVATE_BASE_CLASSES = {
-    "_ChatUserBaseFilter": "MessageFilter",
-    "_Dice": "MessageFilter",
-    "_BaseThumbedMedium": "TelegramObject",
-    "_BaseMedium": "TelegramObject",
-    "_CredentialsBase": "TelegramObject",
-}
-
-
-FILE_ROOT = Path(inspect.getsourcefile(telegram)).parent.parent.resolve()
-
-
-def autodoc_skip_member(app, what, name, obj, skip, options):
-    """We use this to not document certain members like filter() or check_update() for filters.
-    See https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#skipping-members"""
-
-    included = {"MessageFilter", "UpdateFilter"}  # filter() and check_update() only for these.
-    included_in_obj = any(inc in repr(obj) for inc in included)
-
-    if included_in_obj:  # it's difficult to see if check_update is from an inherited-member or not
-        for frame in inspect.stack():  # From https://github.com/sphinx-doc/sphinx/issues/9533
-            if frame.function == "filter_members":
-                docobj = frame.frame.f_locals["self"].object
-                if not any(inc in str(docobj) for inc in included) and name == "check_update":
-                    return True
-                break
-
-    if name == "filter" and obj.__module__ == "telegram.ext.filters":
-        if not included_in_obj:
-            return True  # return True to exclude from docs.
-
-
-def autodoc_process_docstring(
-    app: Sphinx, what, name: str, obj: object, options, lines: list[str]
-):
-    """We do the following things:
-    1) Use this method to automatically insert the Keyword Args and "Shortcuts" admonitions
-       for the Bot methods.
-
-    2) Use this method to automatically insert "Returned in" admonition into classes
-       that are returned from the Bot methods
-
-    3) Use this method to automatically insert "Available in" admonition into classes
-       whose instances are available as attributes of other classes
-
-    4) Use this method to automatically insert "Use in" admonition into classes
-       whose instances can be used as arguments of the Bot methods
-
-    5) Misuse this autodoc hook to get the file names & line numbers because we have access
-       to the actual object here.
-    """
-
-    # 1) Insert the Keyword Args and "Shortcuts" admonitions for the Bot methods
-    method_name = name.split(".")[-1]
-    if (
-        name.startswith("telegram.Bot.")
-        and what == "method"
-        and method_name.islower()
-        and check_timeout_and_api_kwargs_presence(obj)
-    ):
-        insert_index = find_insert_pos_for_kwargs(lines)
-        if not insert_index:
-            raise ValueError(
-                f"Couldn't find the correct position to insert the keyword args for {obj}."
-            )
-
-        long_write_timeout = is_write_timeout_20(obj)
-        get_updates_sub = 1 if (method_name == "get_updates") else 0
-        # The below can be done in 1 line with itertools.chain, but this must be modified in-place
-        for i in range(insert_index, insert_index + len(keyword_args)):
-            lines.insert(
-                i,
-                keyword_args[i - insert_index].format(
-                    method=method_name,
-                    write_timeout=write_timeout_sub[long_write_timeout],
-                    read_timeout=read_timeout_sub[get_updates_sub],
-                    read_timeout_type=read_timeout_type[get_updates_sub],
-                ),
-            )
-
-        ADMONITION_INSERTER.insert_admonitions(
-            obj=typing.cast(collections.abc.Callable, obj),
-            docstring_lines=lines,
-        )
-
-    # 2-4) Insert "Returned in", "Available in", "Use in" admonitions into classes
-    # (where applicable)
-    if what == "class":
-        ADMONITION_INSERTER.insert_admonitions(
-            obj=typing.cast(type, obj),  # since "what" == class, we know it's not just object
-            docstring_lines=lines,
-        )
-
-    # 5) Get the file names & line numbers
-    # We can't properly handle ordinary attributes.
-    # In linkcode_resolve we'll resolve to the `__init__` or module instead
-    if what == "attribute":
-        return
-
-    # Special casing for properties
-    if hasattr(obj, "fget"):
-        obj = obj.fget
-
-    # Special casing for filters
-    if isinstance(obj, telegram.ext.filters.BaseFilter):
-        obj = obj.__class__
-
-    try:
-        source_lines, start_line = inspect.getsourcelines(obj)
-        end_line = start_line + len(source_lines)
-        file = Path(inspect.getsourcefile(obj)).relative_to(FILE_ROOT)
-        LINE_NUMBERS[name] = (file, start_line, end_line)
-    except Exception:
-        pass
-
-    # Since we don't document the `__init__`, we call this manually to have it available for
-    # attributes -- see the note above
-    if what == "class":
-        autodoc_process_docstring(app, "method", f"{name}.__init__", obj.__init__, options, lines)
-
-
-def autodoc_process_bases(app, name, obj, option, bases: list):
-    """Here we fine tune how the base class's classes are displayed."""
-    for idx, base in enumerate(bases):
-        # let's use a string representation of the object
-        base = str(base)
-
-        # Special case for abstract context managers which are wrongly resoled for some reason
-        if base.startswith("typing.AbstractAsyncContextManager"):
-            bases[idx] = ":class:`contextlib.AbstractAsyncContextManager`"
-            continue
-
-        # Special case because base classes are in std lib:
-        if "StringEnum" in base == "<enum 'StringEnum'>":
-            bases[idx] = ":class:`enum.Enum`"
-            bases.insert(0, ":class:`str`")
-            continue
-
-        if "IntEnum" in base:
-            bases[idx] = ":class:`enum.IntEnum`"
-            continue
-
-        # Drop generics (at least for now)
-        if base.endswith("]"):
-            base = base.split("[", maxsplit=1)[0]
-            bases[idx] = f":class:`{base}`"
-
-        # Now convert `telegram._message.Message` to `telegram.Message` etc
-        if (
-            not (match := re.search(pattern=r"(telegram(\.ext|))\.[_\w\.]+", string=base))
-            or "_utils" in base
-        ):
-            continue
-
-        parts = match.group(0).split(".")
-
-        # Remove private paths
-        for index, part in enumerate(parts):
-            if part.startswith("_"):
-                parts = parts[:index] + parts[-1:]
-                break
-
-        # Replace private base classes with their respective parent
-        parts = [PRIVATE_BASE_CLASSES.get(part, part) for part in parts]
-
-        base = ".".join(parts)
-
-        bases[idx] = f":class:`{base}`"

docs/auxil/tg_const_role.py

@@ -1,92 +0,0 @@
-#
-#  A library that provides a Python interface to the Telegram Bot API
-#  Copyright (C) 2015-2023
-#  Leandro Toledo de Souza <devs@python-telegram-bot.org>
-#
-#  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/].
-from enum import Enum
-
-from docutils.nodes import Element
-from sphinx.domains.python import PyXRefRole
-from sphinx.environment import BuildEnvironment
-from sphinx.util import logging
-
-import telegram
-
-# get the sphinx(!) logger
-# Makes sure logs render in red and also plays nicely with e.g. the `nitpicky` option.
-sphinx_logger = logging.getLogger(__name__)
-
-CONSTANTS_ROLE = "tg-const"
-
-
-class TGConstXRefRole(PyXRefRole):
-    """This is a bit of Sphinx magic. We add a new role type called tg-const that allows us to
-    reference values from the `telegram.constants.module` while using the actual value as title
-    of the link.
-
-    Example:
-
-        :tg-const:`telegram.constants.MessageLimit.MAX_TEXT_LENGTH` renders as `4096` but links to
-        the constant.
-    """
-
-    def process_link(
-        self,
-        env: BuildEnvironment,
-        refnode: Element,
-        has_explicit_title: bool,
-        title: str,
-        target: str,
-    ) -> tuple[str, str]:
-        title, target = super().process_link(env, refnode, has_explicit_title, title, target)
-        try:
-            # We use `eval` to get the value of the expression. Maybe there are better ways to
-            # do this via importlib or so, but it does the job for now
-            value = eval(target)
-            # Maybe we need a better check if the target is actually from tg.constants
-            # for now checking if it's an Enum suffices since those are used nowhere else in PTB
-            if isinstance(value, Enum):
-                # Special casing for file size limits
-                if isinstance(value, telegram.constants.FileSizeLimit):
-                    return f"{int(value.value / 1e6)} MB", target
-                return repr(value.value), target
-            # Just for (Bot API) versions number auto add in constants:
-            if isinstance(value, str) and target in (
-                "telegram.constants.BOT_API_VERSION",
-                "telegram.__version__",
-            ):
-                return value, target
-            if isinstance(value, tuple) and target in (
-                "telegram.constants.BOT_API_VERSION_INFO",
-                "telegram.__version_info__",
-            ):
-                return repr(value), target
-            sphinx_logger.warning(
-                f"%s:%d: WARNING: Did not convert reference %s. :{CONSTANTS_ROLE}: is not supposed"
-                " to be used with this type of target.",
-                refnode.source,
-                refnode.line,
-                refnode.rawsource,
-            )
-            return title, target
-        except Exception as exc:
-            sphinx_logger.exception(
-                "%s:%d: WARNING: Did not convert reference %s due to an exception.",
-                refnode.source,
-                refnode.line,
-                refnode.rawsource,
-                exc_info=exc,
-            )
-            return title, target

docs/requirements-docs.txt

@@ -1,8 +1,6 @@
-sphinx==7.2.5
+sphinx==3.5.4
 sphinx-pypi-upload
-furo==2023.8.19
-git+https://github.com/harshil21/furo-sphinx-search@v0.2.0.1
-sphinx-paramlinks==0.6.0
-sphinxcontrib-mermaid==0.9.2
-sphinx-copybutton==0.5.2
-sphinx-inline-tabs==2023.4.21
+# 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

docs/source/_static/style_admonitions.css

@@ -1,65 +0,0 @@
-:root {
-  --icon--shortcuts: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' fill='currentColor' class='bi bi-signpost' viewBox='0 0 16 16'%3E%3Cpath d='M7 1.414V4H2a1 1 0 0 0-1 1v4a1 1 0 0 0 1 1h5v6h2v-6h3.532a1 1 0 0 0 .768-.36l1.933-2.32a.5.5 0 0 0 0-.64L13.3 4.36a1 1 0 0 0-.768-.36H9V1.414a1 1 0 0 0-2 0zM12.532 5l1.666 2-1.666 2H2V5h10.532z'/%3E%3C/svg%3E");
-  --icon--returned-in: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' fill='currentColor' class='bi bi-arrow-return-right' viewBox='0 0 16 16'%3E%3Cpath fill-rule='evenodd' d='M1.5 1.5A.5.5 0 0 0 1 2v4.8a2.5 2.5 0 0 0 2.5 2.5h9.793l-3.347 3.346a.5.5 0 0 0 .708.708l4.2-4.2a.5.5 0 0 0 0-.708l-4-4a.5.5 0 0 0-.708.708L13.293 8.3H3.5A1.5 1.5 0 0 1 2 6.8V2a.5.5 0 0 0-.5-.5z'/%3E%3C/svg%3E");
-  --icon--available-in: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' fill='currentColor' class='bi bi-geo-fill' viewBox='0 0 16 16'%3E%3Cpath fill-rule='evenodd' d='M4 4a4 4 0 1 1 4.5 3.969V13.5a.5.5 0 0 1-1 0V7.97A4 4 0 0 1 4 3.999zm2.493 8.574a.5.5 0 0 1-.411.575c-.712.118-1.28.295-1.655.493a1.319 1.319 0 0 0-.37.265.301.301 0 0 0-.057.09V14l.002.008a.147.147 0 0 0 .016.033.617.617 0 0 0 .145.15c.165.13.435.27.813.395.751.25 1.82.414 3.024.414s2.273-.163 3.024-.414c.378-.126.648-.265.813-.395a.619.619 0 0 0 .146-.15.148.148 0 0 0 .015-.033L12 14v-.004a.301.301 0 0 0-.057-.09 1.318 1.318 0 0 0-.37-.264c-.376-.198-.943-.375-1.655-.493a.5.5 0 1 1 .164-.986c.77.127 1.452.328 1.957.594C12.5 13 13 13.4 13 14c0 .426-.26.752-.544.977-.29.228-.68.413-1.116.558-.878.293-2.059.465-3.34.465-1.281 0-2.462-.172-3.34-.465-.436-.145-.826-.33-1.116-.558C3.26 14.752 3 14.426 3 14c0-.599.5-1 .961-1.243.505-.266 1.187-.467 1.957-.594a.5.5 0 0 1 .575.411z'/%3E%3C/svg%3E");
-  --icon--use-in:url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' fill='currentColor' class='bi bi-funnel' viewBox='0 0 16 16'%3E%3Cpath d='M1.5 1.5A.5.5 0 0 1 2 1h12a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-.128.334L10 8.692V13.5a.5.5 0 0 1-.342.474l-3 1A.5.5 0 0 1 6 14.5V8.692L1.628 3.834A.5.5 0 0 1 1.5 3.5v-2zm1 .5v1.308l4.372 4.858A.5.5 0 0 1 7 8.5v5.306l2-.666V8.5a.5.5 0 0 1 .128-.334L13.5 3.308V2h-11z'/%3E%3C/svg%3E");
-}
-.admonition.shortcuts {
-  border-color: rgb(43, 155, 70);
-}
-.admonition.shortcuts > .admonition-title {
-  background-color: rgba(43, 155, 70, 0.1);
-  border-color: rgb(43, 155, 70);
-}
-.admonition.shortcuts > .admonition-title::before {
-  background-color: rgb(43, 155, 70);
-  -webkit-mask-image: var(--icon--shortcuts);
-  mask-image: var(--icon--shortcuts);
-}
-
-.admonition.returned-in {
-  border-color: rgb(230, 109, 15);
-}
-.admonition.returned-in > .admonition-title {
-  background-color: rgba(177, 108, 51, 0.1);
-  border-color: rgb(230, 109, 15);
-}
-.admonition.returned-in > .admonition-title::before {
-  background-color: rgb(230, 109, 15);
-  -webkit-mask-image: var(--icon--returned-in);
-  mask-image: var(--icon--returned-in);
-}
-
-.admonition.available-in {
-  border-color: rgb(183, 4, 215);
-}
-.admonition.available-in > .admonition-title {
-  background-color: rgba(165, 99, 177, 0.1);
-  border-color: rgb(183, 4, 215);
-}
-.admonition.available-in > .admonition-title::before {
-  background-color: rgb(183, 4, 215);
-  -webkit-mask-image: var(--icon--available-in);
-  mask-image: var(--icon--available-in);
-}
-
-.admonition.use-in {
-  border-color: rgb(203, 147, 1);
-}
-.admonition.use-in > .admonition-title {
-  background-color: rgba(176, 144, 60, 0.1);
-  border-color: rgb(203, 147, 1);
-}
-.admonition.use-in > .admonition-title::before {
-  background-color: rgb(203, 147, 1);
-  -webkit-mask-image: var(--icon--use-in);
-  mask-image: var(--icon--use-in);
-}
-
-.admonition.returned-in > ul:hover, .admonition.available-in > ul:hover, .admonition.use-in > ul:hover, .admonition.shortcuts > ul:hover {
-  cursor: move;
-}
-.admonition.returned-in > ul, .admonition.available-in > ul, .admonition.use-in > ul, .admonition.shortcuts > ul {
-  max-height: 200px;
-  overflow-y: scroll;
-}

docs/source/_static/style_external_link.css

@@ -1,5 +0,0 @@
-article a.reference.external:not([href*="/python-telegram-bot/blob/"])::after {
-      content: url('data:image/svg+xml,<svg width="12" height="12" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" stroke-width="1.5" stroke="%23607D8B" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z"/><path d="M11 7h-5a2 2 0 0 0 -2 2v9a2 2 0 0 0 2 2h9a2 2 0 0 0 2 -2v-5" /><line x1="10" y1="14" x2="20" y2="4" /><polyline points="15 4 20 4 20 9" /></svg>');
-      margin: 0 0.25rem;
-      vertical-align: middle;
-}

docs/source/_static/style_general.css

@@ -1,3 +0,0 @@
-.article-container h1 {
-      overflow-wrap: anywhere;
-}

docs/source/_static/style_images.css

@@ -1,15 +0,0 @@
-figure > img {
-    height: 300px;  /* resize figures so they aren't too big */
-}
-
-@media (prefers-color-scheme: dark) {
-    body:not([data-theme="light"]) figure > img {  /* auto and dark is dark mode */
-        filter: invert(92%);
-    }
-}
-
-@media (prefers-color-scheme: light) {
-    body[data-theme="dark"] figure > img {  /* auto and light is light mode */
-        filter: invert(92%);
-    }
-}

docs/source/_static/style_mermaid_diagrams.css

@@ -1,3 +0,0 @@
-.mermaid svg {
-  height: auto;
-}

docs/source/_static/style_sidebar_brand.css

@@ -1,11 +0,0 @@
-.sidebar-sticky .sidebar-brand {
-      flex-direction: row;
-}
-
-.sidebar-sticky .sidebar-brand .sidebar-logo-container {
-      align-self: center;
-}
-
-.sidebar-sticky .sidebar-brand .sidebar-brand-text {
-      align-self: center;
-}

docs/source/coc.rst

@@ -1 +0,0 @@
-.. include:: ../../CODE_OF_CONDUCT.rst

docs/source/conf.py

@@ -1,274 +1,274 @@
-import os
-import re
+# -*- coding: utf-8 -*-
+#
+# Python Telegram Bot documentation build configuration file, created by
+# sphinx-quickstart on Mon Aug 10 22:25:07 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
 import sys
-from pathlib import Path
+import os
+# import telegram
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-from sphinx.application import Sphinx
-
-sys.path.insert(0, os.path.abspath("../.."))
+sys.path.insert(0, os.path.abspath('../..'))
 
 # -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+needs_sphinx = '3.5.2'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon'
+]
+# Don't show type hints in the signature - that just makes it hardly readable
+# and we document the types anyway
+autodoc_typehints = 'none'
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
 # General information about the project.
-project = "python-telegram-bot"
-copyright = "2015-2023, Leandro Toledo"
-author = "Leandro Toledo"
+project = u'python-telegram-bot'
+copyright = u'2015-2021, Leandro Toledo'
+author = u'Leandro Toledo'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = "20.5"  # telegram.__version__[:3]
+version = '13.13'  # telegram.__version__[:3]
 # The full version, including alpha/beta/rc tags.
-release = "20.5"  # telegram.__version__
+release = '13.13'  # telegram.__version__
 
-# If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = "6.1.3"
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.napoleon",
-    "sphinx.ext.intersphinx",
-    "sphinx.ext.linkcode",
-    "sphinx.ext.extlinks",
-    "sphinx_paramlinks",
-    "sphinx_copybutton",
-    "sphinx_inline_tabs",
-    "sphinxcontrib.mermaid",
-    "sphinx_search.extension",
-]
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
 
-# For shorter links to Wiki in docstrings
-extlinks = {
-    "wiki": ("https://github.com/python-telegram-bot/python-telegram-bot/wiki/%s", "%s"),
-    "pr": ("https://github.com/python-telegram-bot/python-telegram-bot/pull/%s", "#%s"),
-    "issue": ("https://github.com/python-telegram-bot/python-telegram-bot/issues/%s", "#%s"),
-}
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
 
-# Use intersphinx to reference the python builtin library docs
-intersphinx_mapping = {
-    "python": ("https://docs.python.org/3", None),
-    "APScheduler": ("https://apscheduler.readthedocs.io/en/3.x/", None),
-}
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
 
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
 
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-source_suffix = ".rst"
-
-# The master toctree document.
-master_doc = "index"
-
-# Global substitutions
-rst_prolog = (Path.cwd() / "../substitutions/global.rst").read_text(encoding="utf-8")
-
-# -- Extension settings ------------------------------------------------
-napoleon_use_admonition_for_examples = True
-
-# Don't show type hints in the signature - that just makes it hardly readable
-# and we document the types anyway
-autodoc_typehints = "none"
-
-# Fail on warnings & unresolved references etc
-nitpicky = True
-
-# Paramlink style
-paramlinks_hyperlink_param = "name"
-
-# Linkcheck settings
-linkcheck_ignore = [
-    # Let's not check issue/PR links - that's wasted resources
-    r"http(s)://github\.com/python-telegram-bot/python-telegram-bot/(issues|pull)/\d+/?",
-    # For some reason linkcheck has a problem with these two:
-    re.escape("https://github.com/python-telegram-bot/python-telegram-bot/discussions/new"),
-    re.escape("https://github.com/python-telegram-bot/python-telegram-bot/issues/new"),
-    # Anchors are apparently inserted by GitHub dynamically, so let's skip checking them
-    "https://github.com/python-telegram-bot/python-telegram-bot/tree/master/examples#",
-    r"https://github\.com/python-telegram-bot/python-telegram-bot/wiki/[\w\-_,]+\#",
-]
-linkcheck_allowed_redirects = {
-    # Redirects to the default version are okay
-    r"https://docs\.python-telegram-bot\.org/.*": r"https://docs\.python-telegram-bot\.org/en/[\w\d\.]+/.*",
-    # pre-commit.ci always redirects to the latest run
-    re.escape(
-        "https://results.pre-commit.ci/latest/github/python-telegram-bot/python-telegram-bot/master"
-    ): r"https://results\.pre-commit\.ci/run/github/.*",
-}
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
 
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
+pygments_style = 'sphinx'
 
-# Decides the language used for syntax highlighting of code blocks.
-highlight_language = "python3"
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
+
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "furo"
+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.
+# further.  For a list of options available for each theme, see the
+# documentation.
 html_theme_options = {
-    "navigation_with_keys": True,
-    "dark_css_variables": {
-        "admonition-title-font-size": "0.95rem",
-        "admonition-font-size": "0.92rem",
-    },
-    "light_css_variables": {
-        "admonition-title-font-size": "0.95rem",
-        "admonition-font-size": "0.92rem",
-    },
-    "announcement": "PTB has undergone significant changes in v20. Please read the documentation "
-    "carefully and also check out the transition guide in the "
-    '<a href="https://github.com/python-telegram-bot/python-telegram-bot/wiki/'
-    'Transition-guide-to-Version-20.0">wiki</a>.',
-    "footer_icons": [
-        {
-            # Telegram channel logo
-            "name": "Telegram Channel",
-            "url": "https://t.me/pythontelegrambotchannel/",
-            # Following svg is from https://react-icons.github.io/react-icons/search?q=telegram
-            "html": '<svg stroke="currentColor" fill="currentColor" stroke-width="0" '
-            'viewBox="0 0 16 16" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg">'
-            '<path d="M16 8A8 8 0 1 1 0 8a8 8 0 0 1 16 0zM8.287 5.906c-.778.324-2.334.994'
-            "-4.666 2.01-.378.15-.577.298-.595.442-.03.243.275.339.69.47l.175.055c.408.133."
-            "958.288 1.243.294.26.006.549-.1.868-.32 2.179-1.471 3.304-2.214 3.374-2.23.0"
-            "5-.012.12-.026.166.016.047.041.042.12.037.141-.03.129-1.227 1.241-1.846 1.81"
-            "7-.193.18-.33.307-.358.336a8.154 8.154 0 0 1-.188.186c-.38.366-.664.64.015 1.08"
-            "8.327.216.589.393.85.571.284.194.568.387.936.629.093.06.183.125.27.187.331.23"
-            "6.63.448.997.414.214-.02.435-.22.547-.82.265-1.417.786-4.486.906-5.751a1.426 "
-            "1.426 0 0 0-.013-.315.337.337 0 0 0-.114-.217.526.526 0 0 0-.31-.093c-.3.005-.7"
-            '63.166-2.984 1.09z"></path></svg>',
-            "class": "",
-        },
-        {  # Github logo
-            "name": "GitHub",
-            "url": "https://github.com/python-telegram-bot/python-telegram-bot/",
-            "html": '<svg stroke="currentColor" fill="currentColor" stroke-width="0" '
-            'viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 '
-            "2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.4"
-            "9-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23"
-            ".82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 "
-            "0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.2"
-            "7 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.5"
-            "1.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 "
-            '1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z">'
-            "</path></svg>",
-            "class": "",
-        },
-        {  # PTB website logo - globe
-            "name": "python-telegram-bot website",
-            "url": "https://python-telegram-bot.org/",
-            "html": '<svg stroke="currentColor" fill="currentColor" stroke-width="0" '
-            'viewBox="0 0 16 16" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg">'
-            '<path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8zm7.5-6.923c-.67.204-1.335.82-1.887 '
-            "1.855-.143.268-.276.56-.395.872.705.157 1.472.257 2.282.287V1.077zM4.249 3.53"
-            "9c.142-.384.304-.744.481-1.078a6.7 6.7 0 0 1 .597-.933A7.01 7.01 0 0 0 3.051 "
-            "3.05c.362.184.763.349 1.198.49zM3.509 7.5c.036-1.07.188-2.087.436-3.008a9.124 "
-            "9.124 0 0 1-1.565-.667A6.964 6.964 0 0 0 1.018 7.5h2.49zm1.4-2.741a12.344 "
-            "12.344 0 0 0-.4 2.741H7.5V5.091c-.91-.03-1.783-.145-2.591-.332zM8.5 5.09V7.5h"
-            "2.99a12.342 12.342 0 0 0-.399-2.741c-.808.187-1.681.301-2.591.332zM4.51 8.5c.03"
-            "5.987.176 1.914.399 2.741A13.612 13.612 0 0 1 7.5 10.91V8.5H4.51zm3.99 0v2.409"
-            "c.91.03 1.783.145 2.591.332.223-.827.364-1.754.4-2.741H8.5zm-3.282 3.696c.12.31"
-            "2.252.604.395.872.552 1.035 1.218 1.65 1.887 1.855V11.91c-.81.03-1.577.13-2.28"
-            "2.287zm.11 2.276a6.696 6.696 0 0 1-.598-.933 8.853 8.853 0 0 1-.481-1.079 8.38 "
-            "8.38 0 0 0-1.198.49 7.01 7.01 0 0 0 2.276 1.522zm-1.383-2.964A13.36 13.36 0 0 1"
-            " 3.508 8.5h-2.49a6.963 6.963 0 0 0 1.362 3.675c.47-.258.995-.482 1.565-.667zm"
-            "6.728 2.964a7.009 7.009 0 0 0 2.275-1.521 8.376 8.376 0 0 0-1.197-.49 8.853 "
-            "8.853 0 0 1-.481 1.078 6.688 6.688 0 0 1-.597.933zM8.5 11.909v3.014c.67-.204 "
-            "1.335-.82 1.887-1.855.143-.268.276-.56.395-.872A12.63 12.63 0 0 0 8.5 11.91zm"
-            "3.555-.401c.57.185 1.095.409 1.565.667A6.963 6.963 0 0 0 14.982 8.5h-2.49a1"
-            "3.36 13.36 0 0 1-.437 3.008zM14.982 7.5a6.963 6.963 0 0 0-1.362-3.675c-.47.25"
-            "8-.995.482-1.565.667.248.92.4 1.938.437 3.008h2.49zM11.27 2.461c.177.334.339.6"
-            "94.482 1.078a8.368 8.368 0 0 0 1.196-.49 7.01 7.01 0 0 0-2.275-1.52c.218.283.4"
-            "18.597.597.932zm-.488 1.343a7.765 7.765 0 0 0-.395-.872C9.835 1.897 9.17 1.282 "
-            '8.5 1.077V4.09c.81-.03 1.577-.13 2.282-.287z"></path></svg>',
-            "class": "",
-        },
-    ],
+    'style_external_links': True,
 }
 
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-html_title = f"python-telegram-bot<br> v{version}"
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-html_logo = "ptb-logo_1024.png"
+html_logo = 'ptb-logo-orange.png'
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-html_favicon = "ptb-logo_1024.ico"
+html_favicon = 'ptb-logo-orange.ico'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
-html_css_files = [
-    "style_external_link.css",
-    "style_mermaid_diagrams.css",
-    "style_sidebar_brand.css",
-    "style_general.css",
-    "style_admonitions.css",
-    "style_images.css",
-]
+html_static_path = ['_static']
 
-html_permalinks_icon = "¶"  # Furo's default permalink icon is `#` which doesn't look great imo.
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "python-telegram-bot-doc"
-
-# The base URL which points to the root of the HTML documentation. It is used to indicate the
-# location of document using The Canonical Link Relation. Default: ''.
-html_baseurl = "https://docs.python-telegram-bot.org"
+htmlhelp_basename = 'python-telegram-bot-doc'
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    "papersize": "a4paper",
-    # The font size ('10pt', '11pt' or '12pt').
-    #'pointsize': '10pt',
-    # Additional stuff for the LaTeX preamble.
-    "preamble": r"""\setcounter{tocdepth}{2}
+
+# The paper size ('letterpaper' or 'a4paper').
+    'papersize': 'a4paper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+    'preamble': r'''\setcounter{tocdepth}{2}
 \usepackage{enumitem}
-\setlistdepth{99}""",
-    # Latex figure (float) alignment
-    #'figure_align': 'htbp',
+\setlistdepth{99}''',
+
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, "python-telegram-bot.tex", "python-telegram-bot Documentation", author, "manual"),
+  (master_doc, 'python-telegram-bot.tex', u'python-telegram-bot Documentation',
+   author, 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-latex_logo = "ptb-logo_1024.png"
+latex_logo = 'ptb-logo_1024.png'
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "python-telegram-bot", "python-telegram-bot Documentation", [author], 1)]
+man_pages = [
+    (master_doc, 'python-telegram-bot', u'python-telegram-bot Documentation',
+     [author], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
 
-# rtd_sphinx_search_file_type = "un-minified"  # Configuration for furo-sphinx-search
 
 # -- Options for Texinfo output -------------------------------------------
 
@@ -276,33 +276,34 @@ man_pages = [(master_doc, "python-telegram-bot", "python-telegram-bot Documentat
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (
-        master_doc,
-        "python-telegram-bot",
-        "python-telegram-bot Documentation",
-        author,
-        "python-telegram-bot",
-        "We have made you a wrapper you can't refuse",
-        "Miscellaneous",
-    ),
+  (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'),
 ]
 
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+# Napoleon stuff
+
+napoleon_use_admonition_for_examples = True
+
 # -- script stuff --------------------------------------------------------
 
-# Due to Sphinx behaviour, these imports only work when imported here, not at top of module.
 
-# Not used but must be imported for the linkcode extension to find it
-from docs.auxil.link_code import linkcode_resolve
-from docs.auxil.sphinx_hooks import (
-    autodoc_process_bases,
-    autodoc_process_docstring,
-    autodoc_skip_member,
-)
-from docs.auxil.tg_const_role import CONSTANTS_ROLE, TGConstXRefRole
+def autodoc_skip_member(app, what, name, obj, skip, options):
+    pass
 
 
-def setup(app: Sphinx):
-    app.connect("autodoc-skip-member", autodoc_skip_member)
-    app.connect("autodoc-process-bases", autodoc_process_bases)
-    app.connect("autodoc-process-docstring", autodoc_process_docstring)
-    app.add_role_to_domain("py", CONSTANTS_ROLE, TGConstXRefRole())
+def setup(app):
+    app.add_css_file("dark.css")
+    app.connect('autodoc-skip-member', autodoc_skip_member)

docs/source/contributing.rst

@@ -1 +0,0 @@
-.. include:: ../../.github/CONTRIBUTING.rst

docs/source/examples.arbitrarycallbackdatabot.rst

@@ -1,7 +0,0 @@
-``arbitrarycallbackdatabot.py``
-===============================
-
-.. literalinclude:: ../../examples/arbitrarycallbackdatabot.py
-   :language: python
-   :linenos:
-    

docs/source/examples.chatmemberbot.rst

@@ -1,7 +0,0 @@
-``chatmemberbot.py``
-====================
-
-.. literalinclude:: ../../examples/chatmemberbot.py
-   :language: python
-   :linenos:
-    

docs/source/examples.contexttypesbot.rst

@@ -1,7 +0,0 @@
-``contexttypesbot.py``
-======================
-
-.. literalinclude:: ../../examples/contexttypesbot.py
-   :language: python
-   :linenos:
-    

docs/source/examples.conversationbot.rst

@@ -1,13 +0,0 @@
-``conversationbot.py``
-======================
-
-.. literalinclude:: ../../examples/conversationbot.py
-   :language: python
-   :linenos:
-
-.. _conversationbot-diagram:
-
-State Diagram
--------------
-
-.. mermaid:: ../../examples/conversationbot.mmd

docs/source/examples.conversationbot2.rst

@@ -1,13 +0,0 @@
-``conversationbot2.py``
-=======================
-
-.. literalinclude:: ../../examples/conversationbot2.py
-   :language: python
-   :linenos:
-
-.. _conversationbot2-diagram:
-
-State Diagram
--------------
-
-.. mermaid:: ../../examples/conversationbot2.mmd

docs/source/examples.customwebhookbot.rst

@@ -1,43 +0,0 @@
-``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:
-    

docs/source/examples.deeplinking.rst

@@ -1,7 +0,0 @@
-``deeplinking.py``
-==================
-
-.. literalinclude:: ../../examples/deeplinking.py
-   :language: python
-   :linenos:
-    

docs/source/examples.echobot.rst

@@ -1,7 +0,0 @@
-``echobot.py``
-==============
-
-.. literalinclude:: ../../examples/echobot.py
-   :language: python
-   :linenos:
-    

docs/source/examples.errorhandlerbot.rst

@@ -1,7 +0,0 @@
-``errorhandlerbot.py``
-======================
-
-.. literalinclude:: ../../examples/errorhandlerbot.py
-   :language: python
-   :linenos:
-    

docs/source/examples.inlinebot.rst

@@ -1,7 +0,0 @@
-``inlinebot.py``
-================
-
-.. literalinclude:: ../../examples/inlinebot.py
-   :language: python
-   :linenos:
-    

docs/source/examples.inlinekeyboard.rst

@@ -1,7 +0,0 @@
-``inlinekeyboard.py``
-=====================
-
-.. literalinclude:: ../../examples/inlinekeyboard.py
-   :language: python
-   :linenos:
-    

docs/source/examples.inlinekeyboard2.rst

@@ -1,7 +0,0 @@
-``inlinekeyboard2.py``
-======================
-
-.. literalinclude:: ../../examples/inlinekeyboard2.py
-   :language: python
-   :linenos:
-    

docs/source/examples.nestedconversationbot.rst

@@ -1,13 +0,0 @@
-``nestedconversationbot.py``
-============================
-
-.. literalinclude:: ../../examples/nestedconversationbot.py
-   :language: python
-   :linenos:
-
-.. _nestedconversationbot-diagram:
-
-State Diagram
--------------
-
-.. mermaid:: ../../examples/nestedconversationbot.mmd

docs/source/examples.passportbot.rst

@@ -1,16 +0,0 @@
-``passportbot.py``
-==================
-
-.. literalinclude:: ../../examples/passportbot.py
-   :language: python
-   :linenos:
-
-.. _passportbot-html:
-
-HTML Page
----------
-
-.. literalinclude:: ../../examples/passportbot.html
-   :language: html
-   :linenos:
-    

docs/source/examples.paymentbot.rst

@@ -1,7 +0,0 @@
-``paymentbot.py``
-=================
-
-.. literalinclude:: ../../examples/paymentbot.py
-   :language: python
-   :linenos:
-    

docs/source/examples.persistentconversationbot.rst

@@ -1,7 +0,0 @@
-``persistentconversationbot.py``
-================================
-
-.. literalinclude:: ../../examples/persistentconversationbot.py
-   :language: python
-   :linenos:
-    

docs/source/examples.pollbot.rst

@@ -1,7 +0,0 @@
-``pollbot.py``
-==============
-
-.. literalinclude:: ../../examples/pollbot.py
-   :language: python
-   :linenos:
-    

docs/source/examples.rawapibot.rst

@@ -1,11 +0,0 @@
-`rawapibot.py`
-==============
-
-This example uses only the pure, "bare-metal" API wrapper.
-
-
-
-.. literalinclude:: ../../examples/rawapibot.py
-   :language: python
-   :linenos:
-    

docs/source/examples.rst

@@ -1,196 +0,0 @@
-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 <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.
-
-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 <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Extensions---JobQueue>`__.
-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 <conversationbot-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 <conversationbot2-diagram>`.
-for this one, too!
-
-:any:`examples.nestedconversationbot`
--------------------------------------
-
-A 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 <nestedconversationbot-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 <https://github.com/python-telegram-bot/python-telegram-bot/wiki/InlineKeyboard-Example>`__.
-
-: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 <https://core.telegram.org/bots/inline>`__. Don’t forget to enable
-inline mode with `@BotFather <https://telegram.me/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 <passportbot-html>`.
-Don’t forget to enable and configure payments with
-`@BotFather <https://telegram.me/BotFather>`_. Check out this
-`guide <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Telegram-Passport>`__
-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 <https://telegram.me/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 <https://core.telegram.org/bots/webapps>`__ can be used. Use in
-combination with the :ref:`HTML page <webappbot-html>`.
-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 <https://iro.js.org>`__ 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
-

docs/source/examples.timerbot.rst

@@ -1,7 +0,0 @@
-``timerbot.py``
-===============
-
-.. literalinclude:: ../../examples/timerbot.py
-   :language: python
-   :linenos:
-    

docs/source/examples.webappbot.rst

@@ -1,16 +0,0 @@
-``webappbot.py``
-================
-
-.. literalinclude:: ../../examples/webappbot.py
-   :language: python
-   :linenos:
-
-.. _webappbot-html:
-
-HTML Page
----------
-
-.. literalinclude:: ../../examples/webappbot.html
-   :language: html
-   :linenos:
-    

docs/source/inclusions/application_run_tip.rst

@@ -1,9 +0,0 @@
-.. tip::
-    * When combining ``python-telegram-bot`` with other :mod:`asyncio` based frameworks, using this
-      method is likely not the best choice, as it blocks the event loop until it receives a stop
-      signal as described above.
-      Instead, you can manually call the methods listed below to start and shut down the application
-      and the :attr:`~telegram.ext.Application.updater`.
-      Keeping the event loop running and listening for a stop signal is then up to you.
-    * To gracefully stop the execution of this method from within a handler, job or error callback,
-      use :meth:`~telegram.ext.Application.stop_running`.

docs/source/inclusions/bot_methods.rst

@@ -1,408 +0,0 @@
-.. raw:: html
-
-   <hr style="height:2px;border-width:0;color:gray;background-color:gray">
-   <p>Since this class has a large number of methods and attributes, below you can find a quick overview.
-
-   </p>
-   <details>
-   <summary>Sending Messages</summary>
-
-.. list-table::
-        :align: left
-        :widths: 1 4
-
-        * - :meth:`~telegram.Bot.send_animation`
-          - Used for sending animations
-        * - :meth:`~telegram.Bot.send_audio`
-          - Used for sending audio files
-        * - :meth:`~telegram.Bot.send_chat_action`
-          - Used for sending chat actions
-        * - :meth:`~telegram.Bot.send_contact`
-          - Used for sending contacts
-        * - :meth:`~telegram.Bot.send_dice`
-          - Used for sending dice messages
-        * - :meth:`~telegram.Bot.send_document`
-          - Used for sending documents
-        * - :meth:`~telegram.Bot.send_game`
-          - Used for sending a game
-        * - :meth:`~telegram.Bot.send_invoice`
-          - Used for sending an invoice
-        * - :meth:`~telegram.Bot.send_location`
-          - Used for sending location
-        * - :meth:`~telegram.Bot.send_media_group`
-          - Used for sending media grouped together
-        * - :meth:`~telegram.Bot.send_message`
-          - Used for sending text messages
-        * - :meth:`~telegram.Bot.send_photo`
-          - Used for sending photos
-        * - :meth:`~telegram.Bot.send_poll`
-          - Used for sending polls
-        * - :meth:`~telegram.Bot.send_sticker`
-          - Used for sending stickers
-        * - :meth:`~telegram.Bot.send_venue`
-          - Used for sending venue locations.
-        * - :meth:`~telegram.Bot.send_video`
-          - Used for sending videos
-        * - :meth:`~telegram.Bot.send_video_note`
-          - Used for sending video notes
-        * - :meth:`~telegram.Bot.send_voice`
-          - Used for sending voice messages
-        * - :meth:`~telegram.Bot.copy_message`
-          - Used for copying the contents of an arbitrary message
-        * - :meth:`~telegram.Bot.forward_message`
-          - Used for forwarding messages
-
-.. raw:: html
-
-   </details>
-   <br>
-
-.. raw:: html
-
-   <details>
-   <summary>Updating Messages</summary>
-
-.. list-table::
-    :align: left
-    :widths: 1 4
-
-    * - :meth:`~telegram.Bot.answer_callback_query`
-      - Used for answering the callback query
-    * - :meth:`~telegram.Bot.answer_inline_query`
-      - Used for answering the inline query
-    * - :meth:`~telegram.Bot.answer_pre_checkout_query`
-      - Used for answering a pre checkout query
-    * - :meth:`~telegram.Bot.answer_shipping_query`
-      - Used for answering a shipping query
-    * - :meth:`~telegram.Bot.answer_web_app_query`
-      - Used for answering a web app query
-    * - :meth:`~telegram.Bot.edit_message_caption`
-      - Used for editing captions
-    * - :meth:`~telegram.Bot.edit_message_media`
-      - Used for editing the media on messages
-    * - :meth:`~telegram.Bot.edit_message_live_location`
-      - Used for editing the location in live location messages
-    * - :meth:`~telegram.Bot.edit_message_reply_markup`
-      - Used for editing the reply markup on messages
-    * - :meth:`~telegram.Bot.edit_message_text`
-      - Used for editing text messages
-    * - :meth:`~telegram.Bot.stop_poll`
-      - Used for stopping the running poll
-    * - :meth:`~telegram.Bot.delete_message`
-      - Used for deleting messages.
-
-.. raw:: html
-
-   </details>
-   <br>
-
-.. raw:: html
-
-   <details>
-   <summary>Chat Moderation and information</summary>
-
-.. list-table::
-    :align: left
-    :widths: 1 4
-
-    * - :meth:`~telegram.Bot.ban_chat_member`
-      - Used for banning a member from the chat
-    * - :meth:`~telegram.Bot.unban_chat_member`
-      - Used for unbanning a member from the chat
-    * - :meth:`~telegram.Bot.ban_chat_sender_chat`
-      - Used for banning a channel in a channel or supergroup
-    * - :meth:`~telegram.Bot.unban_chat_sender_chat`
-      - Used for unbanning a channel in a channel or supergroup
-    * - :meth:`~telegram.Bot.restrict_chat_member`
-      - Used for restricting a chat member
-    * - :meth:`~telegram.Bot.promote_chat_member`
-      - Used for promoting a chat member
-    * - :meth:`~telegram.Bot.set_chat_administrator_custom_title`
-      - Used for assigning a custom admin title to an admin
-    * - :meth:`~telegram.Bot.set_chat_permissions`
-      - Used for setting the permissions of a chat
-    * - :meth:`~telegram.Bot.export_chat_invite_link`
-      - Used for creating a new primary invite link for a chat
-    * - :meth:`~telegram.Bot.create_chat_invite_link`
-      - Used for creating an additional invite link for a chat
-    * - :meth:`~telegram.Bot.edit_chat_invite_link`
-      - Used for editing a non-primary invite link
-    * - :meth:`~telegram.Bot.revoke_chat_invite_link`
-      - Used for revoking an invite link created by the bot
-    * - :meth:`~telegram.Bot.approve_chat_join_request`
-      - Used for approving a chat join request
-    * - :meth:`~telegram.Bot.decline_chat_join_request`
-      - Used for declining a chat join request
-    * - :meth:`~telegram.Bot.set_chat_photo`
-      - Used for setting a photo to a chat
-    * - :meth:`~telegram.Bot.delete_chat_photo`
-      - Used for deleting a chat photo
-    * - :meth:`~telegram.Bot.set_chat_title`
-      - Used for setting a chat title
-    * - :meth:`~telegram.Bot.set_chat_description`
-      - Used for setting the description of a chat
-    * - :meth:`~telegram.Bot.pin_chat_message`
-      - Used for pinning a message
-    * - :meth:`~telegram.Bot.unpin_chat_message`
-      - Used for unpinning a message
-    * - :meth:`~telegram.Bot.unpin_all_chat_messages`
-      - Used for unpinning all pinned chat messages
-    * - :meth:`~telegram.Bot.get_user_profile_photos`
-      - Used for obtaining user's profile pictures
-    * - :meth:`~telegram.Bot.get_chat`
-      - Used for getting information about a chat
-    * - :meth:`~telegram.Bot.get_chat_administrators`
-      - Used for getting the list of admins in a chat
-    * - :meth:`~telegram.Bot.get_chat_member_count`
-      - Used for getting the number of members in a chat
-    * - :meth:`~telegram.Bot.get_chat_member`
-      - Used for getting a member of a chat
-    * - :meth:`~telegram.Bot.leave_chat`
-      - Used for leaving a chat
-
-.. raw:: html
-
-   </details>
-   <br>
-
-.. raw:: html
-
-   <details>
-   <summary>Bot settings</summary>
-
-.. list-table::
-    :align: left
-    :widths: 1 4
-
-    * - :meth:`~telegram.Bot.set_my_commands`
-      - Used for setting the list of commands
-    * - :meth:`~telegram.Bot.delete_my_commands`
-      - Used for deleting the list of commands
-    * - :meth:`~telegram.Bot.get_my_commands`
-      - Used for obtaining the list of commands
-    * - :meth:`~telegram.Bot.get_my_default_administrator_rights`
-      - Used for obtaining the default administrator rights for the bot
-    * - :meth:`~telegram.Bot.set_my_default_administrator_rights`
-      - Used for setting the default administrator rights for the bot
-    * - :meth:`~telegram.Bot.get_chat_menu_button`
-      - Used for obtaining the menu button of a private chat or the default menu button
-    * - :meth:`~telegram.Bot.set_chat_menu_button`
-      - Used for setting the menu button of a private chat or the default menu button
-    * - :meth:`~telegram.Bot.set_my_description`
-      - Used for setting the description of the bot
-    * - :meth:`~telegram.Bot.get_my_description`
-      - Used for obtaining the description of the bot
-    * - :meth:`~telegram.Bot.set_my_short_description`
-      - Used for setting the short description of the bot
-    * - :meth:`~telegram.Bot.get_my_short_description`
-      - Used for obtaining the short description of the bot
-    * - :meth:`~telegram.Bot.set_my_name`
-      - Used for setting the name of the bot
-    * - :meth:`~telegram.Bot.get_my_name`
-      - Used for obtaining the name of the bot
-
-.. raw:: html
-
-   </details>
-   <br>
-
-.. raw:: html
-
-   <details>
-   <summary>Stickerset management</summary>
-
-.. list-table::
-    :align: left
-    :widths: 1 4
-
-    * - :meth:`~telegram.Bot.add_sticker_to_set`
-      - Used for adding a sticker to a set
-    * - :meth:`~telegram.Bot.delete_sticker_from_set`
-      - Used for deleting a sticker from a set
-    * - :meth:`~telegram.Bot.create_new_sticker_set`
-      - Used for creating a new sticker set
-    * - :meth:`~telegram.Bot.delete_sticker_set`
-      - Used for deleting a sticker set made by a bot
-    * - :meth:`~telegram.Bot.set_chat_sticker_set`
-      - Used for setting a sticker set of a chat
-    * - :meth:`~telegram.Bot.delete_chat_sticker_set`
-      - Used for deleting the set sticker set of a chat
-    * - :meth:`~telegram.Bot.set_sticker_position_in_set`
-      - Used for moving a sticker's position in the set
-    * - :meth:`~telegram.Bot.set_sticker_set_title`
-      - Used for setting the title of a sticker set
-    * - :meth:`~telegram.Bot.set_sticker_emoji_list`
-      - Used for setting the emoji list of a sticker
-    * - :meth:`~telegram.Bot.set_sticker_keywords`
-      - Used for setting the keywords of a sticker
-    * - :meth:`~telegram.Bot.set_sticker_mask_position`
-      - Used for setting the mask position of a mask sticker
-    * - :meth:`~telegram.Bot.set_sticker_set_thumbnail`
-      - Used for setting the thumbnail of a sticker set
-    * - :meth:`~telegram.Bot.set_custom_emoji_sticker_set_thumbnail`
-      - Used for setting the thumbnail of a custom emoji sticker set
-    * - :meth:`~telegram.Bot.get_sticker_set`
-      - Used for getting a sticker set
-    * - :meth:`~telegram.Bot.upload_sticker_file`
-      - Used for uploading a sticker file
-    * - :meth:`~telegram.Bot.get_custom_emoji_stickers`
-      - Used for getting custom emoji files based on their IDs
-
-.. raw:: html
-
-   </details>
-   <br>
-
-.. raw:: html
-
-   <details>
-   <summary>Games</summary>
-
-.. list-table::
-    :align: left
-    :widths: 1 4
-
-    * - :meth:`~telegram.Bot.get_game_high_scores`
-      - Used for getting the game high scores
-    * - :meth:`~telegram.Bot.set_game_score`
-      - Used for setting the game score
-
-.. raw:: html
-
-   </details>
-   <br>
-
-.. raw:: html
-
-   <details>
-   <summary>Getting updates</summary>
-
-.. list-table::
-    :align: left
-    :widths: 1 4
-
-    * - :meth:`~telegram.Bot.get_updates`
-      - Used for getting updates using long polling
-    * - :meth:`~telegram.Bot.get_webhook_info`
-      - Used for getting current webhook status
-    * - :meth:`~telegram.Bot.set_webhook`
-      - Used for setting a webhook to receive updates
-    * - :meth:`~telegram.Bot.delete_webhook`
-      - Used for removing webhook integration
-
-.. raw:: html
-
-   </details>
-   <br>
-
-.. raw:: html
-
-   <details>
-   <summary>Forum topic management</summary>
-
-.. list-table::
-    :align: left
-    :widths: 1 4
-
-    * - :meth:`~telegram.Bot.close_forum_topic`
-      - Used for closing a forum topic
-    * - :meth:`~telegram.Bot.close_general_forum_topic`
-      - Used for closing the general forum topic
-    * - :meth:`~telegram.Bot.create_forum_topic`
-      - Used to create a topic
-    * - :meth:`~telegram.Bot.delete_forum_topic`
-      - Used for deleting a forum topic
-    * - :meth:`~telegram.Bot.edit_forum_topic`
-      - Used to edit a topic
-    * - :meth:`~telegram.Bot.edit_general_forum_topic`
-      - Used to edit the general topic
-    * - :meth:`~telegram.Bot.get_forum_topic_icon_stickers`
-      - Used to get custom emojis to use as topic icons
-    * - :meth:`~telegram.Bot.hide_general_forum_topic`
-      - Used to hide the general topic
-    * - :meth:`~telegram.Bot.unhide_general_forum_topic`
-      - Used to unhide the general topic
-    * - :meth:`~telegram.Bot.reopen_forum_topic`
-      - Used to reopen a topic
-    * - :meth:`~telegram.Bot.reopen_general_forum_topic`
-      - Used to reopen the general topic
-    * - :meth:`~telegram.Bot.unpin_all_forum_topic_messages`
-      - Used to unpin all messages in a forum topic
-    * - :meth:`~telegram.Bot.unpin_all_general_forum_topic_messages`
-      - Used to unpin all messages in the general forum topic
-
-.. raw:: html
-
-   </details>
-   <br>
-
-.. raw:: html
-
-   <details>
-   <summary>Miscellaneous</summary>
-
-.. list-table::
-    :align: left
-    :widths: 1 4
-
-    * - :meth:`~telegram.Bot.create_invoice_link`
-      - Used to generate an HTTP link for an invoice
-    * - :meth:`~telegram.Bot.close`
-      - Used for closing server instance when switching to another local server
-    * - :meth:`~telegram.Bot.log_out`
-      - Used for logging out from cloud Bot API server
-    * - :meth:`~telegram.Bot.get_file`
-      - Used for getting basic info about a file
-    * - :meth:`~telegram.Bot.get_me`
-      - Used for getting basic information about the bot
-
-.. raw:: html
-
-   </details>
-   <br>
-
-.. raw:: html
-
-   <details>
-   <summary>Properties</summary>
-
-.. list-table::
-    :align: left
-    :widths: 1 4
-
-    * - :attr:`~telegram.Bot.base_file_url`
-      - Telegram Bot API file URL
-    * - :attr:`~telegram.Bot.base_url`
-      - Telegram Bot API service URL
-    * - :attr:`~telegram.Bot.bot`
-      - The user instance of the bot as returned by :meth:`~telegram.Bot.get_me`
-    * - :attr:`~telegram.Bot.can_join_groups`
-      - Whether the bot can join groups
-    * - :attr:`~telegram.Bot.can_read_all_group_messages`
-      - Whether the bot can read all incoming group messages
-    * - :attr:`~telegram.Bot.id`
-      - The user id of the bot
-    * - :attr:`~telegram.Bot.name`
-      - The username of the bot, with leading ``@``
-    * - :attr:`~telegram.Bot.first_name`
-      - The first name of the bot
-    * - :attr:`~telegram.Bot.last_name`
-      - The last name of the bot
-    * - :attr:`~telegram.Bot.local_mode`
-      - Whether the bot is running in local mode
-    * - :attr:`~telegram.Bot.username`
-      - The username of the bot, without leading ``@``
-    * - :attr:`~telegram.Bot.link`
-      - The t.me link of the bot
-    * - :attr:`~telegram.Bot.private_key`
-      - Deserialized private key for decryption of telegram passport data
-    * - :attr:`~telegram.Bot.supports_inline_queries`
-      - Whether the bot supports inline queries
-    * - :attr:`~telegram.Bot.token`
-      - Bot's unique authentication token
-
-.. raw:: html
-
-   </details>
-   <br>
-   <hr style="height:2px;border-width:0;color:gray;background-color:gray">

docs/source/inclusions/menu_button_command_video.rst

@@ -1,3 +0,0 @@
-.. raw:: html
-
-    <center><video height="300px" loop autoplay muted><source src="https://core.telegram.org/file/464001555/10fbd/jvTuV2Ke7WQ.1916669.mp4/a056de323645db409d" type="video/mp4"></video></center>

docs/source/inclusions/pool_size_tip.rst

@@ -1,10 +0,0 @@
-.. tip::
-    When making requests to the Bot API in an asynchronous fashion (e.g. via
-    :attr:`block=False <telegram.ext.BaseHandler.block>`, :meth:`Application.create_task <telegram.ext.Application.create_task>`,
-    :meth:`~telegram.ext.ApplicationBuilder.concurrent_updates` or the :class:`~telegram.ext.JobQueue`), it can happen that more requests
-    are being made in parallel than there are connections in the pool.
-    If the number of requests is much higher than the number of connections, even setting
-    :meth:`~telegram.ext.ApplicationBuilder.pool_timeout` to a larger value may not always be enough to prevent pool
-    timeouts.
-    You should therefore set :meth:`~telegram.ext.ApplicationBuilder.concurrent_updates`, :meth:`~telegram.ext.ApplicationBuilder.connection_pool_size` and
-    :meth:`~telegram.ext.ApplicationBuilder.pool_timeout` to values that make sense for your setup.

docs/source/index.rst

@@ -3,36 +3,39 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-.. include:: ../../README.rst
+Welcome to Python Telegram Bot's documentation!
+===============================================
 
-.. The toctrees are hidden such that they don't render on the start page but still include the contents into the documentation.
+Guides and tutorials
+====================
+
+If you're just starting out with the library, we recommend following our `"Your first Bot" <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Extensions-%E2%80%93-Your-first-Bot>`_ tutorial that you can find on our `wiki <https://github.com/python-telegram-bot/python-telegram-bot/wiki>`_.
+On our wiki you will also find guides like how to use handlers, webhooks, emoji, proxies and much more.
+
+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>`_.
 
 .. toctree::
-   :hidden:
-   :caption: Reference
-
-   telegram
    telegram.ext
-   telegram_auxil
-   Telegrams Bot API Docs <https://core.telegram.org/bots/api>
 
 .. toctree::
-   :hidden:
-   :caption: Resources
+   telegram
 
-   examples
-   Wiki <https://github.com/python-telegram-bot/python-telegram-bot/wiki>
+Changelog
+---------
 
 .. toctree::
-   :hidden:
-   :caption: Project
+   :maxdepth: 2
 
-   stability_policy
    changelog
-   coc
-   contributing
-   testing
-   Website <https://python-telegram-bot.org>
-   GitHub Repository <https://github.com/python-telegram-bot/python-telegram-bot/>
-   Telegram Channel <https://t.me/pythontelegrambotchannel/>
-   Telegram User Group <https://t.me/pythontelegrambotgroup/>
+
+

docs/source/stability_policy.rst

@@ -1,146 +0,0 @@
-Stability Policy
-================
-
-.. important::
-
-    This stability policy is in place since version 20.3.
-    While earlier versions of ``python-telegram-bot`` also had stable interfaces, they had no explicit stability policy and hence did not follow the rules outlined below in all detail.
-    Please also refer to the :ref:`changelog <ptb-changelog>`.
-
-.. caution::
-
-    Large parts of the :mod:`telegram` package are the Python representations of the Telegram Bot API, whose stability policy PTB can not influence.
-    This policy hence includes some special cases for those parts.
-
-What does this policy cover?
-----------------------------
-
-This policy includes any API or behavior that is covered in this documentation.
-This covers both the :mod:`telegram` package and the :mod:`telegram.ext` package.
-
-What doesn't this policy cover?
--------------------------------
-
-Introduction of new features or changes of flavors of comparable behavior (e.g. the default for the HTTP protocol version being used) are not covered by this policy.
-
-The internal structure of classes in PTB, i.e. things like the result of ``dir(obj))`` or the contents of ``obj.__dict__``, is not covered by this policy.
-
-Objects are in general not guaranteed to be pickleable (unless stated otherwise) and pickled objects from one version of PTB may not be loadable in future versions.
-We may provide a way to convert pickled objects from one version to another, but this is not guaranteed.
-
-Functionality that is part of PTBs API but is explicitly documented as not being intended to be used directly by users (e.g. :meth:`telegram.request.BaseRequest.do_request`) may change.
-This also applies to functions or attributes marked as final in the sense of `PEP 591 <https://peps.python.org/pep-0591/>`__.
-
-PTB has dependencies to third-party packages.
-The versions that PTB uses of these third-party packages may change if that does not affect PTBs public API.
-
-PTB does not give guarantees about which Python versions are supported.
-In general, we will try to support all Python versions that have not yet reached their end of life, but we reserve ourselves the option to drop support for Python versions earlier if that benefits the advancement of the library.
-
-PTB provides static type hints for all public attributes, parameters, return values and generic classes.
-These type hints are not covered by this policy and may change at any time under the condition that these changes have no impact on the runtime behavior of PTB.
-
-.. _bot-api-functionality-1:
-
-Bot API Functionality
-~~~~~~~~~~~~~~~~~~~~~
-
-Comparison of equality of instances of the classes in the :mod:`telegram` package is subject to change and the PTB team will update the behavior to best reflect updates in the Bot API.
-Changes in this regard will be documented in the affected classes.
-Note that equality comparison with objects that where serialized by an older version of PTB may hence give unexpected results.
-
-When the order of arguments of the Bot API methods changes or they become optional/mandatory due to changes in the Bot API, PTB will always try to reflect these changes.
-While we try to make such changes backward compatible, this is not always possible or only with significant effort.
-In such cases we will find a trade-off between backward compatibility and fully complying with the Bot API, which may result in breaking changes.
-We highly recommend using keyword arguments, which can help make such changes non-breaking on your end.
-
-..
-    We have documented a few common cases and possible backwards compatible solutions in the wiki as a reference for the dev team: https://github.com/python-telegram-bot/python-telegram-bot/wiki/Bot-API-Backward-Compatibility
-
-When the Bot API changes attributes of classes, the method :meth:`telegram.TelegramObject.to_dict` will change as necessary to reflect these changes.
-In particular, attributes deprecated by Telegram will be removed from the returned dictionary.
-Deprecated attributes that are still passed by Telegram will be available in the :attr:`~telegram.TelegramObject.api_kwargs` dictionary as long as PTB can support that with feasible effort.
-Since attributes of the classes in the :mod:`telegram` package are not writable, we may change them to properties where appropriate.
-
-Development Versions
-~~~~~~~~~~~~~~~~~~~~
-
-Pre-releases marked as alpha, beta or release candidate are not covered by this policy.
-Before a feature is in a stable release, i.e. the feature was merged into the ``master`` branch but not released yet (or only in a pre-release), it is not covered by this policy either and may change.
-
-Security
-~~~~~~~~
-
-We make exceptions from our stability policy for security.
-We will violate this policy as necessary in order to resolve a security issue or harden PTB against a possible attack.
-
-Versioning
-----------
-
-PTB uses a versioning scheme that roughly follows `https://semver.org/ <https://semver.org/>`_, although it may not be quite as strict.
-
-Given a version of PTB X.Y.Z,
-
--  X indicates the major version number.
-   This is incremented when backward incompatible changes are introduced.
--  Y indicates the minor version number.
-   This is incremented when new functionality or backward compatible changes are introduced by PTB.
-   *This is also incremented when PTB adds support for a new Bot API version, which may include backward incompatible changes in some cases as outlined* :ref:`below <bot-api-versioning>`.
--  Z is the patch version.
-   This is incremented if backward compatible bug fixes or smaller changes are introduced.
-   If this number is 0, it can be omitted, i.e. we just write X.Y instead of X.Y.0.
-
-Deprecation
-~~~~~~~~~~~
-
-From time to time we will want to change the behavior of an API or remove it entirely, or we do so to comply with changes in the Telegram Bot API.
-In those cases, we follow a deprecation schedule as detailed below.
-
-Functionality is marked as deprecated by a corresponding note in the release notes and the documentation.
-Where possible, a :class:`~telegram.warnings.PTBDeprecationWarning` is issued when deprecated functionality is used, but this is not mandatory.
-
-From time to time, we may decide to deprecate an API that is particularly widely used.
-In these cases, we may decide to provide an extended deprecation period, at our discretion.
-
-With version 20.0.0, PTB introduced major structural breaking changes without the above deprecation period.
-Should a similarly big change ever be deemed necessary again by the development team and should a deprecation period prove too much additional effort, this violation of the stability policy will be announced well ahead of the release in our channel, `as was done for v20 <https://t.me/pythontelegrambotchannel/94>`_.
-
-Non-Bot API Functionality
-#########################
-
-Starting with version 20.3, deprecated functionality will stay available for the current and the next major version.
-For example:
-
--  In PTB v20.1.1 the feature exists
--  In PTB v20.1.2 or v20.2.0 the feature is marked as deprecated
--  In PTB v21.*.* the feature is marked as deprecated
--  In PTB v22.0 the feature is removed or changed
-
-.. _bot-api-versioning:
-
-Bot API Functionality
-#####################
-
-As PTB has no control over deprecations introduced by Telegram and the schedule of these deprecations rarely coincides with PTBs deprecation schedule, we have a special policy for Bot API functionality.
-
-Starting with 20.3, deprecated Bot API functionality will stay available for the current and the next major version of PTB *or* until the next version of the Bot API.
-More precisely, two cases are possible, for which we show examples below.
-
-Case 1
-^^^^^^
-
--  In PTB v20.1 the feature exists
--  Bot API version 6.6 is released and deprecates the feature
--  PTB v20.2 adds support for Bot API 6.6 and the feature is
-   marked as deprecated
--  In PTB v21.0 the feature is removed or changed
-
-Case 2
-^^^^^^
-
--  In PTB v20.1 the feature exists
--  Bot API version 6.6 is released and deprecates the feature
--  PTB v20.2 adds support for Bot API version 6.6 and the feature is marked as deprecated
--  In PTB v20.2.* and v20.3.* the feature is marked as deprecated
--  Bot API version 6.7 is released
--  PTB v20.4 adds support for Bot API version 6.7 and the feature is removed or changed

docs/source/telegram.animation.rst

@@ -1,9 +1,8 @@
-Animation
-=========
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/animation.py
 
-.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject
+telegram.Animation
+==================
 
 .. autoclass:: telegram.Animation
     :members:
     :show-inheritance:
-    :inherited-members: TelegramObject

docs/source/telegram.at-tree.rst

@@ -1,101 +0,0 @@
-Available Types
----------------
-
-.. toctree::
-    :titlesonly:
-
-    telegram.animation
-    telegram.audio
-    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.callbackquery
-    telegram.chat
-    telegram.chatadministratorrights
-    telegram.chatinvitelink
-    telegram.chatjoinrequest
-    telegram.chatlocation
-    telegram.chatmember
-    telegram.chatmemberadministrator
-    telegram.chatmemberbanned
-    telegram.chatmemberleft
-    telegram.chatmembermember
-    telegram.chatmemberowner
-    telegram.chatmemberrestricted
-    telegram.chatmemberupdated
-    telegram.chatpermissions
-    telegram.chatphoto
-    telegram.chatshared
-    telegram.contact
-    telegram.dice
-    telegram.document
-    telegram.file
-    telegram.forcereply
-    telegram.forumtopic
-    telegram.forumtopicclosed
-    telegram.forumtopiccreated
-    telegram.forumtopicedited
-    telegram.forumtopicreopened
-    telegram.generalforumtopichidden
-    telegram.generalforumtopicunhidden
-    telegram.inlinekeyboardbutton
-    telegram.inlinekeyboardmarkup
-    telegram.inputfile
-    telegram.inputmedia
-    telegram.inputmediaanimation
-    telegram.inputmediaaudio
-    telegram.inputmediadocument
-    telegram.inputmediaphoto
-    telegram.inputmediavideo
-    telegram.inputsticker
-    telegram.keyboardbutton
-    telegram.keyboardbuttonpolltype
-    telegram.keyboardbuttonrequestchat
-    telegram.keyboardbuttonrequestuser
-    telegram.location
-    telegram.loginurl
-    telegram.menubutton
-    telegram.menubuttoncommands
-    telegram.menubuttondefault
-    telegram.menubuttonwebapp
-    telegram.message
-    telegram.messageautodeletetimerchanged
-    telegram.messageentity
-    telegram.messageid
-    telegram.photosize
-    telegram.poll
-    telegram.pollanswer
-    telegram.polloption
-    telegram.proximityalerttriggered
-    telegram.replykeyboardmarkup
-    telegram.replykeyboardremove
-    telegram.sentwebappmessage
-    telegram.story
-    telegram.switchinlinequerychosenchat
-    telegram.telegramobject
-    telegram.update
-    telegram.user
-    telegram.userprofilephotos
-    telegram.usershared
-    telegram.venue
-    telegram.video
-    telegram.videochatended
-    telegram.videochatparticipantsinvited
-    telegram.videochatscheduled
-    telegram.videochatstarted
-    telegram.videonote
-    telegram.voice
-    telegram.webappdata
-    telegram.webappinfo
-    telegram.webhookinfo
-    telegram.writeaccessallowed
-

docs/source/telegram.audio.rst

@@ -1,9 +1,8 @@
-Audio
-=====
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/audio.py
 
-.. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject
+telegram.Audio
+==============
 
 .. autoclass:: telegram.Audio
     :members:
     :show-inheritance:
-    :inherited-members: TelegramObject

docs/source/telegram.bot.rst

@@ -1,7 +1,8 @@
-Bot
-===
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/bot.py
+
+telegram.Bot
+============
 
 .. autoclass:: telegram.Bot
     :members:
-    :show-inheritance:
-    :special-members: __reduce__, __deepcopy__
+    :show-inheritance:

docs/source/telegram.botcommand.rst

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

docs/source/telegram.botcommandscope.rst

@@ -1,5 +1,7 @@
-BotCommandScope
-===============
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py
+
+telegram.BotCommandScope
+========================
 
 .. autoclass:: telegram.BotCommandScope
     :members:

docs/source/telegram.botcommandscopeallchatadministrators.rst

@@ -1,5 +1,7 @@
-BotCommandScopeAllChatAdministrators
-====================================
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py
+
+telegram.BotCommandScopeAllChatAdministrators
+=============================================
 
 .. autoclass:: telegram.BotCommandScopeAllChatAdministrators
     :members:

docs/source/telegram.botcommandscopeallgroupchats.rst

@@ -1,5 +1,7 @@
-BotCommandScopeAllGroupChats
-============================
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py
+
+telegram.BotCommandScopeAllGroupChats
+=======================================
 
 .. autoclass:: telegram.BotCommandScopeAllGroupChats
     :members:

docs/source/telegram.botcommandscopeallprivatechats.rst

@@ -1,5 +1,7 @@
-BotCommandScopeAllPrivateChats
-==============================
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py
+
+telegram.BotCommandScopeAllPrivateChats
+=======================================
 
 .. autoclass:: telegram.BotCommandScopeAllPrivateChats
     :members:

docs/source/telegram.botcommandscopechat.rst

@@ -1,5 +1,7 @@
-BotCommandScopeChat
-===================
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py
+
+telegram.BotCommandScopeChat
+============================
 
 .. autoclass:: telegram.BotCommandScopeChat
     :members:

docs/source/telegram.botcommandscopechatadministrators.rst

@@ -1,5 +1,7 @@
-BotCommandScopeChatAdministrators
-=================================
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py
+
+telegram.BotCommandScopeChatAdministrators
+==========================================
 
 .. autoclass:: telegram.BotCommandScopeChatAdministrators
     :members:

docs/source/telegram.botcommandscopechatmember.rst

@@ -1,5 +1,7 @@
-BotCommandScopeChatMember
-=========================
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py
+
+telegram.BotCommandScopeChatMember
+==================================
 
 .. autoclass:: telegram.BotCommandScopeChatMember
     :members:

docs/source/telegram.botcommandscopedefault.rst

@@ -1,5 +1,7 @@
-BotCommandScopeDefault
-======================
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py
+
+telegram.BotCommandScopeDefault
+===============================
 
 .. autoclass:: telegram.BotCommandScopeDefault
     :members:

docs/source/telegram.botdescription.rst

@@ -1,6 +0,0 @@
-BotDescription
-==============
-
-.. autoclass:: telegram.BotDescription
-    :members:
-    :show-inheritance:

docs/source/telegram.botname.rst

@@ -1,6 +0,0 @@
-BotName
-=======
-
-.. autoclass:: telegram.BotName
-    :members:
-    :show-inheritance:

docs/source/telegram.botshortdescription.rst

@@ -1,6 +0,0 @@
-BotShortDescription
-===================
-
-.. autoclass:: telegram.BotShortDescription
-    :members:
-    :show-inheritance:

docs/source/telegram.callbackgame.rst

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

docs/source/telegram.callbackquery.rst

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

docs/source/telegram.chat.rst

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

docs/source/telegram.chataction.rst

@@ -0,0 +1,8 @@
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chataction.py
+
+telegram.ChatAction
+===================
+
+.. autoclass:: telegram.ChatAction
+    :members:
+    :show-inheritance:

docs/source/telegram.chatadministratorrights.rst

@@ -1,7 +1,7 @@
-ChatAdministratorRights
-=======================
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatadministratorrights.py
 
-.. versionadded:: 20.0
+telegram.ChatAdministratorRights
+================================
 
 .. autoclass:: telegram.ChatAdministratorRights
     :members:

docs/source/telegram.chatinvitelink.rst

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

docs/source/telegram.chatjoinrequest.rst

@@ -1,5 +1,7 @@
-ChatJoinRequest
-===============
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatjoinrequest.py
+
+telegram.ChatJoinRequest
+========================
 
 .. autoclass:: telegram.ChatJoinRequest
     :members:

docs/source/telegram.chatlocation.rst

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

docs/source/telegram.chatmember.rst

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

docs/source/telegram.chatmemberadministrator.rst

@@ -1,5 +1,7 @@
-ChatMemberAdministrator
-=======================
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py
+
+telegram.ChatMemberAdministrator
+================================
 
 .. autoclass:: telegram.ChatMemberAdministrator
     :members:

docs/source/telegram.chatmemberbanned.rst

@@ -1,5 +1,7 @@
-ChatMemberBanned
-================
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py
+
+telegram.ChatMemberBanned
+=========================
 
 .. autoclass:: telegram.ChatMemberBanned
     :members: