Skip to content

DOC: explain WSL GUI backend setup #32386

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

Open
SIBTAIN-ASAD wants to merge 3 commits into
base: main
Choose a base branch
from
+9 −0
Open

DOC: explain WSL GUI backend setup #32386

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c95e91d
docs: explain WSL GUI backend setup
SIBTAIN-ASAD Sep 23, 2026
61e03f3
Move WSL backend guidance next to backend selection
SIBTAIN-ASAD Sep 25, 2026
399236a
Shorten WSL backend guidance
SIBTAIN-ASAD Sep 26, 2026
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
9 changes: 9 additions & 0 deletions galleries/users_explain/figure/backends.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ PyQt/PySide, PyGObject, Tkinter, wxPython, or macOS/Cocoa); also referred to
as "interactive backends") and hardcopy backends to make image files
(PNG, SVG, PDF, PS; also referred to as "non-interactive backends").

.. _selecting-a-backend:

Selecting a backend
-------------------

Expand Down Expand Up @@ -99,6 +101,13 @@ Here is a detailed description of the configuration methods:
use a different backend. Therefore, you should avoid explicitly calling
`~matplotlib.use` unless absolutely necessary.

.. note::
On WSL2, WSLg should make interactive backends work without a separate
X server when a supported GUI toolkit is installed. If it does not,
check that WSLg is running and that ``DISPLAY`` or ``WAYLAND_DISPLAY`` is
defined. For headless WSL sessions, use the non-interactive ``Agg``
backend. See :ref:`the-builtin-backends` and :ref:`selecting-a-backend`.

.. _the-builtin-backends:

The builtin backends
Expand Down
Loading