Skip to content

Documentation Improvements #4810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ The following wonderful people contributed directly or indirectly to this projec
- `Patrick Hofmann <https://github.com/PH89>`_
- `Paul Larsen <https://github.com/PaulSonOfLars>`_
- `Pawan <https://github.com/pawanrai9999>`_
- `Philipp Isachenko <https://github.com/Aweryc>`_
- `Pieter Schutz <https://github.com/eldinnie>`_
- `Piraty <https://github.com/piraty>`_
- `Poolitzer <https://github.com/Poolitzer>`_
Expand Down
2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~~

Expand Down
20 changes: 20 additions & 0 deletions changes/unreleased/4810.KyRnffWk3ARyQFNcF88Uh3.toml
Original file line number Diff line number Diff line change
@@ -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 = []
1 change: 0 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@
"sphinx_copybutton",
"sphinx_inline_tabs",
"sphinxcontrib.mermaid",
"sphinx_search.extension",
]

# Temporary. See #4387
Expand Down
2 changes: 1 addition & 1 deletion docs/source/telegram.animation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Animation
.. autoclass:: telegram.Animation
:members:
:show-inheritance:
:inherited-members: TelegramObject
:inherited-members: TelegramObject, object
2 changes: 1 addition & 1 deletion docs/source/telegram.audio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Audio
.. autoclass:: telegram.Audio
:members:
:show-inheritance:
:inherited-members: TelegramObject
:inherited-members: TelegramObject, object
2 changes: 1 addition & 1 deletion docs/source/telegram.chat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ Chat
.. autoclass:: telegram.Chat
:members:
:show-inheritance:
:inherited-members: TelegramObject
:inherited-members: TelegramObject, object
2 changes: 1 addition & 1 deletion docs/source/telegram.chatfullinfo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ ChatFullInfo
.. autoclass:: telegram.ChatFullInfo
:members:
:show-inheritance:
:inherited-members: TelegramObject
:inherited-members: TelegramObject, object
2 changes: 1 addition & 1 deletion docs/source/telegram.document.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ Document
.. autoclass:: telegram.Document
:members:
:show-inheritance:
:inherited-members: TelegramObject
:inherited-members: TelegramObject, object
2 changes: 1 addition & 1 deletion docs/source/telegram.photosize.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ PhotoSize
.. autoclass:: telegram.PhotoSize
:members:
:show-inheritance:
:inherited-members: TelegramObject
:inherited-members: TelegramObject, object
1 change: 0 additions & 1 deletion docs/source/telegram.revenuewithdrawalstate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ RevenueWithdrawalState
.. autoclass:: telegram.RevenueWithdrawalState
:members:
:show-inheritance:
:inherited-members: TelegramObject
1 change: 0 additions & 1 deletion docs/source/telegram.revenuewithdrawalstatefailed.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ RevenueWithdrawalStateFailed
.. autoclass:: telegram.RevenueWithdrawalStateFailed
:members:
:show-inheritance:
:inherited-members: TelegramObject
1 change: 0 additions & 1 deletion docs/source/telegram.revenuewithdrawalstatepending.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ RevenueWithdrawalStatePending
.. autoclass:: telegram.RevenueWithdrawalStatePending
:members:
:show-inheritance:
:inherited-members: TelegramObject
1 change: 0 additions & 1 deletion docs/source/telegram.revenuewithdrawalstatesucceeded.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ RevenueWithdrawalStateSucceeded
.. autoclass:: telegram.RevenueWithdrawalStateSucceeded
:members:
:show-inheritance:
:inherited-members: TelegramObject
1 change: 0 additions & 1 deletion docs/source/telegram.startransaction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ StarTransaction
.. autoclass:: telegram.StarTransaction
:members:
:show-inheritance:
:inherited-members: TelegramObject
1 change: 0 additions & 1 deletion docs/source/telegram.startransactions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ StarTransactions
.. autoclass:: telegram.StarTransactions
:members:
:show-inheritance:
:inherited-members: TelegramObject

2 changes: 1 addition & 1 deletion docs/source/telegram.sticker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Sticker
.. autoclass:: telegram.Sticker
:members:
:show-inheritance:
:inherited-members: TelegramObject
:inherited-members: TelegramObject, object
1 change: 0 additions & 1 deletion docs/source/telegram.transactionpartner.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ TransactionPartner
.. autoclass:: telegram.TransactionPartner
:members:
:show-inheritance:
:inherited-members: TelegramObject
1 change: 0 additions & 1 deletion docs/source/telegram.transactionpartnerchat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ TransactionPartnerChat
.. autoclass:: telegram.TransactionPartnerChat
:members:
:show-inheritance:
:inherited-members: TransactionPartner
1 change: 0 additions & 1 deletion docs/source/telegram.transactionpartnerfragment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ TransactionPartnerFragment
.. autoclass:: telegram.TransactionPartnerFragment
:members:
:show-inheritance:
:inherited-members: TransactionPartner
1 change: 0 additions & 1 deletion docs/source/telegram.transactionpartnerother.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ TransactionPartnerOther
.. autoclass:: telegram.TransactionPartnerOther
:members:
:show-inheritance:
:inherited-members: TransactionPartner
1 change: 0 additions & 1 deletion docs/source/telegram.transactionpartnertelegramads.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ TransactionPartnerTelegramAds
.. autoclass:: telegram.TransactionPartnerTelegramAds
:members:
:show-inheritance:
:inherited-members: TransactionPartner
1 change: 0 additions & 1 deletion docs/source/telegram.transactionpartnertelegramapi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ TransactionPartnerTelegramApi
.. autoclass:: telegram.TransactionPartnerTelegramApi
:members:
:show-inheritance:
:inherited-members: TransactionPartner
1 change: 0 additions & 1 deletion docs/source/telegram.transactionpartneruser.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ TransactionPartnerUser
.. autoclass:: telegram.TransactionPartnerUser
:members:
:show-inheritance:
:inherited-members: TransactionPartner
2 changes: 1 addition & 1 deletion docs/source/telegram.video.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Video
.. autoclass:: telegram.Video
:members:
:show-inheritance:
:inherited-members: TelegramObject
:inherited-members: TelegramObject, object
2 changes: 1 addition & 1 deletion docs/source/telegram.videonote.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ VideoNote
.. autoclass:: telegram.VideoNote
:members:
:show-inheritance:
:inherited-members: TelegramObject
:inherited-members: TelegramObject, object
2 changes: 1 addition & 1 deletion docs/source/telegram.voice.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Voice
.. autoclass:: telegram.Voice
:members:
:show-inheritance:
:inherited-members: TelegramObject
:inherited-members: TelegramObject, object
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected]",
"sphinx-paramlinks==0.6.0",
"sphinxcontrib-mermaid==1.0.0",
"sphinx-copybutton==0.5.2",
Expand Down
22 changes: 0 additions & 22 deletions src/telegram/_message.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand Down
Loading