Skip to content

Commit 9e0fe21

Browse files
committed
Re-arrange installation doc layout
This ensures that the ToC as generated in the PDF makes sense, and doesn't appear in the wrong order. Also fixes the redirect to come from the right place.
1 parent a99ba43 commit 9e0fe21

File tree

6 files changed

+306
-317
lines changed

6 files changed

+306
-317
lines changed

INSTALL.rst

+1-91
Original file line numberDiff line numberDiff line change
@@ -1,91 +1 @@
1-
############
2-
Installation
3-
############
4-
5-
==============================
6-
Installing an official release
7-
==============================
8-
9-
Matplotlib releases are available as wheel packages for macOS, Windows and
10-
Linux on `PyPI <https://pypi.org/project/matplotlib/>`_. Install it using
11-
``pip``:
12-
13-
.. code-block:: sh
14-
15-
python -m pip install -U pip
16-
python -m pip install -U matplotlib
17-
18-
If this command results in Matplotlib being compiled from source and
19-
there's trouble with the compilation, you can add ``--prefer-binary`` to
20-
select the newest version of Matplotlib for which there is a
21-
precompiled wheel for your OS and Python.
22-
23-
.. note::
24-
25-
The following backends work out of the box: Agg, ps, pdf, svg
26-
27-
Python is typically shipped with tk bindings which are used by
28-
TkAgg.
29-
30-
For support of other GUI frameworks, LaTeX rendering, saving
31-
animations and a larger selection of file formats, you can
32-
install :ref:`optional_dependencies`.
33-
34-
=========================
35-
Third-party distributions
36-
=========================
37-
38-
Various third-parties provide Matplotlib for their environments.
39-
40-
Conda packages
41-
==============
42-
Matplotlib is available both via the *anaconda main channel*
43-
44-
.. code-block:: sh
45-
46-
conda install matplotlib
47-
48-
as well as via the *conda-forge community channel*
49-
50-
.. code-block:: sh
51-
52-
conda install -c conda-forge matplotlib
53-
54-
Python distributions
55-
====================
56-
57-
Matplotlib is part of major Python distributions:
58-
59-
- `Anaconda <https://www.anaconda.com/>`_
60-
61-
- `ActiveState ActivePython
62-
<https://www.activestate.com/products/python/downloads/>`_
63-
64-
- `WinPython <https://winpython.github.io/>`_
65-
66-
Linux package manager
67-
=====================
68-
69-
If you are using the Python version that comes with your Linux distribution,
70-
you can install Matplotlib via your package manager, e.g.:
71-
72-
* Debian / Ubuntu: ``sudo apt-get install python3-matplotlib``
73-
* Fedora: ``sudo dnf install python3-matplotlib``
74-
* Red Hat: ``sudo yum install python3-matplotlib``
75-
* Arch: ``sudo pacman -S python-matplotlib``
76-
77-
======================
78-
Installing from source
79-
======================
80-
See :ref:`install_from_source`.
81-
82-
==========================
83-
Installing for development
84-
==========================
85-
See :ref:`installing_for_devs`.
86-
87-
==============
88-
Installing FAQ
89-
==============
90-
91-
See :ref:`installing-faq`.
1+
See doc/users/installing/index.rst

README.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,9 @@ various graphical user interface toolkits.
5858
Install
5959
=======
6060

61-
For installation instructions and requirements, see `INSTALL.rst <INSTALL.rst>`_ or the
62-
`install <https://matplotlib.org/stable/users/installing.html>`_ documentation.
61+
For installation instructions and requirements, see the `install documentation
62+
<https://matplotlib.org/stable/users/installing/index.html>`_ or
63+
`installing.rst <doc/users/installing/index.rst>`_ in the source.
6364

6465
Contribute
6566
==========

doc/devel/documenting_mpl.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -197,22 +197,22 @@ Documents can be linked with the ``:doc:`` directive:
197197

198198
.. code-block:: rst
199199
200-
See the :doc:`/users/faq/installing_faq`
200+
See the :doc:`/users/installing/index`
201201
202202
See the tutorial :doc:`/tutorials/introductory/usage`
203203
204204
See the example :doc:`/gallery/lines_bars_and_markers/simple_plot`
205205
206206
will render as:
207207

208-
See the :doc:`/users/faq/installing_faq`
208+
See the :doc:`/users/installing/index`
209209

210210
See the tutorial :doc:`/tutorials/introductory/usage`
211211

212212
See the example :doc:`/gallery/lines_bars_and_markers/simple_plot`
213213

214214
Sections can also be given reference names. For instance from the
215-
:doc:`/users/faq/installing_faq` link:
215+
:doc:`/users/installing/index` link:
216216

217217
.. code-block:: rst
218218

doc/users/faq/installing_faq.rst

-139
This file was deleted.

0 commit comments

Comments
 (0)