diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index c4708371ff8..15049ac55af 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -24,6 +24,8 @@ Setting things up 4. Install the package in development mode as well as optional dependencies and development dependencies. Note that the `--group` argument requires `pip` 25.1 or later. + + Alternatively, you can use your preferred package manager (such as uv, hatch, poetry, etc.) instead of pip. .. code-block:: bash diff --git a/AUTHORS.rst b/AUTHORS.rst index 61535397919..46bedf43b46 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -109,6 +109,7 @@ The following wonderful people contributed directly or indirectly to this projec - `Patrick Hofmann `_ - `Paul Larsen `_ - `Pawan `_ +- `Philipp Isachenko `_ - `Pieter Schutz `_ - `Piraty `_ - `Poolitzer `_ diff --git a/README.rst b/README.rst index 27e3fb760df..faf6956cbb0 100644 --- a/README.rst +++ b/README.rst @@ -114,6 +114,8 @@ You can also install ``python-telegram-bot`` from source, though this is usually $ pip install build $ python -m build +You can also use your favored package manager (such as ``uv``, ``hatch``, ``poetry``, etc.) instead of ``pip``. + Verifying Releases ~~~~~~~~~~~~~~~~~~ diff --git a/changes/unreleased/4810.KyRnffWk3ARyQFNcF88Uh3.toml b/changes/unreleased/4810.KyRnffWk3ARyQFNcF88Uh3.toml new file mode 100644 index 00000000000..dcb64b0d66b --- /dev/null +++ b/changes/unreleased/4810.KyRnffWk3ARyQFNcF88Uh3.toml @@ -0,0 +1,20 @@ +documentation = """Documentation Improvements. Among other things + +* mention alternative package managers in README and contribution guide +* remove ``furo-sphinx-search`` +""" + +[[pull_requests]] +uid = "4810" +author_uid = "Bibo-Joshi" +closes_threads = [] + +[[pull_requests]] +uid = "4824" +author_uid = "Aweryc" +closes_threads = ["4823"] + +[[pull_requests]] +uid = "4826" +author_uid = "harshil21" +closes_threads = [] diff --git a/docs/source/conf.py b/docs/source/conf.py index a0352d2c509..86943cb3970 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -51,7 +51,6 @@ "sphinx_copybutton", "sphinx_inline_tabs", "sphinxcontrib.mermaid", - "sphinx_search.extension", ] # Temporary. See #4387 diff --git a/docs/source/telegram.animation.rst b/docs/source/telegram.animation.rst index 94b5f818721..4e654fad49c 100644 --- a/docs/source/telegram.animation.rst +++ b/docs/source/telegram.animation.rst @@ -6,4 +6,4 @@ Animation .. autoclass:: telegram.Animation :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.audio.rst b/docs/source/telegram.audio.rst index 9e501f70141..563de6c0289 100644 --- a/docs/source/telegram.audio.rst +++ b/docs/source/telegram.audio.rst @@ -6,4 +6,4 @@ Audio .. autoclass:: telegram.Audio :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.chat.rst b/docs/source/telegram.chat.rst index d69b08b60e8..df53940c4a7 100644 --- a/docs/source/telegram.chat.rst +++ b/docs/source/telegram.chat.rst @@ -5,4 +5,4 @@ Chat .. autoclass:: telegram.Chat :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.chatfullinfo.rst b/docs/source/telegram.chatfullinfo.rst index 3bbc9fa9e18..7ba8f3d3828 100644 --- a/docs/source/telegram.chatfullinfo.rst +++ b/docs/source/telegram.chatfullinfo.rst @@ -5,4 +5,4 @@ ChatFullInfo .. autoclass:: telegram.ChatFullInfo :members: :show-inheritance: - :inherited-members: TelegramObject \ No newline at end of file + :inherited-members: TelegramObject, object \ No newline at end of file diff --git a/docs/source/telegram.document.rst b/docs/source/telegram.document.rst index e59a84ba674..1a337077069 100644 --- a/docs/source/telegram.document.rst +++ b/docs/source/telegram.document.rst @@ -5,4 +5,4 @@ Document .. autoclass:: telegram.Document :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.paidmeessagepricechanged.rst b/docs/source/telegram.paidmessagepricechanged.rst similarity index 100% rename from docs/source/telegram.paidmeessagepricechanged.rst rename to docs/source/telegram.paidmessagepricechanged.rst diff --git a/docs/source/telegram.photosize.rst b/docs/source/telegram.photosize.rst index be044f1164b..53632ac9bd4 100644 --- a/docs/source/telegram.photosize.rst +++ b/docs/source/telegram.photosize.rst @@ -5,4 +5,4 @@ PhotoSize .. autoclass:: telegram.PhotoSize :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.revenuewithdrawalstate.rst b/docs/source/telegram.revenuewithdrawalstate.rst index d3f7eef81cc..a8b0d9ef0ef 100644 --- a/docs/source/telegram.revenuewithdrawalstate.rst +++ b/docs/source/telegram.revenuewithdrawalstate.rst @@ -4,4 +4,3 @@ RevenueWithdrawalState .. autoclass:: telegram.RevenueWithdrawalState :members: :show-inheritance: - :inherited-members: TelegramObject diff --git a/docs/source/telegram.revenuewithdrawalstatefailed.rst b/docs/source/telegram.revenuewithdrawalstatefailed.rst index ac319c6a67a..63379122869 100644 --- a/docs/source/telegram.revenuewithdrawalstatefailed.rst +++ b/docs/source/telegram.revenuewithdrawalstatefailed.rst @@ -4,4 +4,3 @@ RevenueWithdrawalStateFailed .. autoclass:: telegram.RevenueWithdrawalStateFailed :members: :show-inheritance: - :inherited-members: TelegramObject diff --git a/docs/source/telegram.revenuewithdrawalstatepending.rst b/docs/source/telegram.revenuewithdrawalstatepending.rst index 19a74e5f28c..3c2110271c0 100644 --- a/docs/source/telegram.revenuewithdrawalstatepending.rst +++ b/docs/source/telegram.revenuewithdrawalstatepending.rst @@ -4,4 +4,3 @@ RevenueWithdrawalStatePending .. autoclass:: telegram.RevenueWithdrawalStatePending :members: :show-inheritance: - :inherited-members: TelegramObject diff --git a/docs/source/telegram.revenuewithdrawalstatesucceeded.rst b/docs/source/telegram.revenuewithdrawalstatesucceeded.rst index 7f7980e799f..40bd6fdb5c7 100644 --- a/docs/source/telegram.revenuewithdrawalstatesucceeded.rst +++ b/docs/source/telegram.revenuewithdrawalstatesucceeded.rst @@ -4,4 +4,3 @@ RevenueWithdrawalStateSucceeded .. autoclass:: telegram.RevenueWithdrawalStateSucceeded :members: :show-inheritance: - :inherited-members: TelegramObject diff --git a/docs/source/telegram.startransaction.rst b/docs/source/telegram.startransaction.rst index 42f84e39b67..b8a68c8e99e 100644 --- a/docs/source/telegram.startransaction.rst +++ b/docs/source/telegram.startransaction.rst @@ -4,4 +4,3 @@ StarTransaction .. autoclass:: telegram.StarTransaction :members: :show-inheritance: - :inherited-members: TelegramObject diff --git a/docs/source/telegram.startransactions.rst b/docs/source/telegram.startransactions.rst index 1f1860920b5..e71439c8c87 100644 --- a/docs/source/telegram.startransactions.rst +++ b/docs/source/telegram.startransactions.rst @@ -4,5 +4,4 @@ StarTransactions .. autoclass:: telegram.StarTransactions :members: :show-inheritance: - :inherited-members: TelegramObject diff --git a/docs/source/telegram.sticker.rst b/docs/source/telegram.sticker.rst index 65b4a0f23c6..459629b7ecc 100644 --- a/docs/source/telegram.sticker.rst +++ b/docs/source/telegram.sticker.rst @@ -6,4 +6,4 @@ Sticker .. autoclass:: telegram.Sticker :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.transactionpartner.rst b/docs/source/telegram.transactionpartner.rst index 9ccca02cec0..1970cfb3f94 100644 --- a/docs/source/telegram.transactionpartner.rst +++ b/docs/source/telegram.transactionpartner.rst @@ -4,4 +4,3 @@ TransactionPartner .. autoclass:: telegram.TransactionPartner :members: :show-inheritance: - :inherited-members: TelegramObject diff --git a/docs/source/telegram.transactionpartnerchat.rst b/docs/source/telegram.transactionpartnerchat.rst index d57cf128378..3f278f05d80 100644 --- a/docs/source/telegram.transactionpartnerchat.rst +++ b/docs/source/telegram.transactionpartnerchat.rst @@ -4,4 +4,3 @@ TransactionPartnerChat .. autoclass:: telegram.TransactionPartnerChat :members: :show-inheritance: - :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartnerfragment.rst b/docs/source/telegram.transactionpartnerfragment.rst index c65f9262f81..dbdad66f2df 100644 --- a/docs/source/telegram.transactionpartnerfragment.rst +++ b/docs/source/telegram.transactionpartnerfragment.rst @@ -4,4 +4,3 @@ TransactionPartnerFragment .. autoclass:: telegram.TransactionPartnerFragment :members: :show-inheritance: - :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartnerother.rst b/docs/source/telegram.transactionpartnerother.rst index b0c14f0713c..cbc4c41be52 100644 --- a/docs/source/telegram.transactionpartnerother.rst +++ b/docs/source/telegram.transactionpartnerother.rst @@ -4,4 +4,3 @@ TransactionPartnerOther .. autoclass:: telegram.TransactionPartnerOther :members: :show-inheritance: - :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartnertelegramads.rst b/docs/source/telegram.transactionpartnertelegramads.rst index ce9a52a117f..8304bc84a06 100644 --- a/docs/source/telegram.transactionpartnertelegramads.rst +++ b/docs/source/telegram.transactionpartnertelegramads.rst @@ -4,4 +4,3 @@ TransactionPartnerTelegramAds .. autoclass:: telegram.TransactionPartnerTelegramAds :members: :show-inheritance: - :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartnertelegramapi.rst b/docs/source/telegram.transactionpartnertelegramapi.rst index 9aeba6b94b8..619b4a0c89f 100644 --- a/docs/source/telegram.transactionpartnertelegramapi.rst +++ b/docs/source/telegram.transactionpartnertelegramapi.rst @@ -4,4 +4,3 @@ TransactionPartnerTelegramApi .. autoclass:: telegram.TransactionPartnerTelegramApi :members: :show-inheritance: - :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartneruser.rst b/docs/source/telegram.transactionpartneruser.rst index def37495344..7709bd668c4 100644 --- a/docs/source/telegram.transactionpartneruser.rst +++ b/docs/source/telegram.transactionpartneruser.rst @@ -4,4 +4,3 @@ TransactionPartnerUser .. autoclass:: telegram.TransactionPartnerUser :members: :show-inheritance: - :inherited-members: TransactionPartner diff --git a/docs/source/telegram.video.rst b/docs/source/telegram.video.rst index 34c81eb242a..bcda1026431 100644 --- a/docs/source/telegram.video.rst +++ b/docs/source/telegram.video.rst @@ -6,4 +6,4 @@ Video .. autoclass:: telegram.Video :members: :show-inheritance: - :inherited-members: TelegramObject \ No newline at end of file + :inherited-members: TelegramObject, object \ No newline at end of file diff --git a/docs/source/telegram.videonote.rst b/docs/source/telegram.videonote.rst index 5217acb0479..e7b504fb515 100644 --- a/docs/source/telegram.videonote.rst +++ b/docs/source/telegram.videonote.rst @@ -6,4 +6,4 @@ VideoNote .. autoclass:: telegram.VideoNote :members: :show-inheritance: - :inherited-members: TelegramObject \ No newline at end of file + :inherited-members: TelegramObject, object \ No newline at end of file diff --git a/docs/source/telegram.voice.rst b/docs/source/telegram.voice.rst index b3667b6edcb..b1530967bd2 100644 --- a/docs/source/telegram.voice.rst +++ b/docs/source/telegram.voice.rst @@ -6,4 +6,4 @@ Voice .. autoclass:: telegram.Voice :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TelegramObject, object diff --git a/pyproject.toml b/pyproject.toml index 66589c25b0e..ecb8d7b7b9b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -116,7 +116,6 @@ docs = [ "chango~=0.4.0; python_version >= '3.12'", "sphinx==8.2.3; python_version >= '3.11'", "furo==2024.8.6", - "furo-sphinx-search @ git+https://github.com/harshil21/furo-sphinx-search@v0.2.0.1", "sphinx-paramlinks==0.6.0", "sphinxcontrib-mermaid==1.0.0", "sphinx-copybutton==0.5.2", diff --git a/src/telegram/_message.py b/src/telegram/_message.py index 58e18aa0e01..b0fd098eed0 100644 --- a/src/telegram/_message.py +++ b/src/telegram/_message.py @@ -1814,7 +1814,6 @@ async def reply_text( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -1899,7 +1898,6 @@ async def reply_markdown( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -1979,7 +1977,6 @@ async def reply_markdown_v2( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2059,7 +2056,6 @@ async def reply_html( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2137,7 +2133,6 @@ async def reply_media_group( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2218,7 +2213,6 @@ async def reply_photo( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2303,7 +2297,6 @@ async def reply_audio( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2388,7 +2381,6 @@ async def reply_document( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2475,7 +2467,6 @@ async def reply_animation( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2557,7 +2548,6 @@ async def reply_sticker( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2642,7 +2632,6 @@ async def reply_video( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2730,7 +2719,6 @@ async def reply_video_note( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2810,7 +2798,6 @@ async def reply_voice( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2892,7 +2879,6 @@ async def reply_location( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2977,7 +2963,6 @@ async def reply_venue( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -3060,7 +3045,6 @@ async def reply_contact( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -3148,7 +3132,6 @@ async def reply_poll( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -3232,7 +3215,6 @@ async def reply_dice( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -3347,7 +3329,6 @@ async def reply_game( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -3451,7 +3432,6 @@ async def reply_invoice( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -3661,7 +3641,6 @@ async def reply_copy( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -3735,7 +3714,6 @@ async def reply_paid_media( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. Returns: :class:`telegram.Message`: On success, the sent message is returned.