Skip to content

Backport PR #30451 on branch v3.10.x (doc: factor out quick install tab for reuse) #30461

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 24, 2025
+65 −72
Merged

Backport PR #30451 on branch v3.10.x (doc: factor out quick install tab for reuse) #30461

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
55 changes: 4 additions & 51 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,59 +14,12 @@ and interactive visualizations.
Install
=======

.. tab-set::
:class: sd-width-content-min
.. include:: install/quick_install.inc.rst

.. tab-item:: pip
.. toctree::
:hidden:

.. code-block:: bash

pip install matplotlib

.. tab-item:: conda

.. code-block:: bash

conda install -c conda-forge matplotlib

.. tab-item:: pixi

.. code-block:: bash

pixi add matplotlib

.. tab-item:: uv

.. code-block:: bash

uv add matplotlib

.. 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.

.. code-block:: bash

uv add matplotlib pyside6

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

.. tab-item:: other

.. rst-class:: section-toc
.. toctree::
:maxdepth: 2

install/index

For more detailed instructions, see the
:doc:`installation guide <install/index>`.
install/index

Learn
=====
Expand Down
7 changes: 6 additions & 1 deletion doc/install/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
Installation
************

.. include:: quick_install.inc.rst

.. _install-official:

Install an official release
===========================
Expand Down Expand Up @@ -35,6 +38,7 @@ precompiled wheel for your OS and Python.
animations and a larger selection of file formats, you can
install :ref:`optional dependencies <optional_dependencies>`.

.. _install-third-party:

Third-party distributions
=========================
Expand Down Expand Up @@ -81,7 +85,7 @@ you can install Matplotlib via your package manager, e.g.:

.. redirect-from:: /users/installing/installing_source

.. _install_from_source:
.. _install-nightly-build:

Install a nightly build
=======================
Expand All @@ -101,6 +105,7 @@ scientific-python-nightly-wheels as the package index to query:
--extra-index-url https://pypi.org/simple \
matplotlib

.. _install-source:

Install from source
===================
Expand Down
54 changes: 54 additions & 0 deletions doc/install/quick_install.inc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
.. set of quick install commands for reuse across docs

.. tab-set::
:class: sd-width-content-min

.. tab-item:: pip

.. code-block:: bash

pip install matplotlib

.. tab-item:: conda

.. code-block:: bash

conda install -c conda-forge matplotlib

.. tab-item:: pixi

.. code-block:: bash

pixi add matplotlib

.. tab-item:: uv

.. code-block:: bash

uv add matplotlib

.. 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.

.. 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`

:ref:`install-third-party`

:ref:`install-nightly-build`

:ref:`install-source`
21 changes: 1 addition & 20 deletions doc/users/getting_started/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,7 @@ Getting started
Installation quick-start
------------------------

.. grid:: 1 1 2 2

.. grid-item::

Install using `pip <https://pypi.org/project/matplotlib>`__:

.. code-block:: bash

pip install matplotlib

.. grid-item::

Install using `conda <https://docs.continuum.io/anaconda/>`__:

.. code-block:: bash

conda install -c conda-forge matplotlib

Further details are available in the :doc:`Installation Guide </install/index>`.

.. include:: /install/quick_install.inc.rst

Draw a first plot
-----------------
Expand Down
Loading