Thanks to visit codestin.com
Credit goes to github.com

Skip to content

doc: Update warnings about python-build-standalone #30486

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.

Sign up for GitHub

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 1 commit into from
Aug 29, 2025
Merged

doc: Update warnings about python-build-standalone #30486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 14 additions & 5 deletions doc/install/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,20 @@ precompiled wheel for your OS and Python.

.. note::

The following backends work out of the box: Agg, ps, pdf, svg

Python is typically shipped with tk bindings which are used by
TkAgg. Notably, python-build-standalone – used by ``uv`` – does
not include tk bindings that are usable by Matplotlib.
The following non-interactive backends work out of the box: Agg,
ps, pdf, svg

The TkAgg interactive backend also typically works out of the box.
It requires Tk bindings, which are usually provided via the Python
standard library's ``tkinter`` module. On some OSes, you may need
to install a separate package like ``python3-tk`` to add this
component of the standard library.

Some tools like ``uv`` make use of Python builds from the
python-build-standalone project, which only gained usable Tk
bindings recently (August 2025). If you are having trouble with the
TkAgg backend, ensure you have an up-to-date build, e.g. ``uv self
update && uv python upgrade --reinstall``.

For support of other GUI frameworks, LaTeX rendering, saving
animations and a larger selection of file formats, you can
Expand Down
17 changes: 8 additions & 9 deletions doc/install/quick_install.inc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,19 @@

.. warning::

If you install Python with ``uv`` then the ``tkagg`` backend
will not be available because python-build-standalone (used by uv
to distribute Python) does not contain tk bindings that are usable by
Matplotlib (see `this issue`_ for details). If you want Matplotlib
to be able to display plots in a window, you should install one of
the other :ref:`supported GUI frameworks <optional_dependencies>`,
e.g.
uv usually installs its own versions of Python from the
python-build-standalone project, and only recent versions of those
Python builds (August 2025) work properly with the ``tkagg`` backend
for displaying plots in a window. Please make sure you are using uv
0.8.7 or newer (update with e.g. ``uv self update``) and that your
bundled Python installs are up to date (with ``uv python upgrade
--reinstall``). Alternatively, you can use one of the other
:ref:`supported GUI frameworks <optional_dependencies>`, e.g.

.. code-block:: bash

uv add matplotlib pyside6

.. _this issue: https://github.com/astral-sh/uv/issues/6893#issuecomment-2565965851

.. tab-item:: other

:ref:`install-official`
Expand Down
Loading