Skip to content

Commit 9535ca6

Browse files
committed
Moved dependencies under install because its version dependent and
cleaned up the headings a bit
1 parent 07a6f66 commit 9535ca6

File tree

4 files changed

+43
-20
lines changed

4 files changed

+43
-20
lines changed

doc/devel/development_setup.rst

+11-1
Original file line numberDiff line numberDiff line change
@@ -155,9 +155,16 @@ Remember to activate the environment whenever you start working on Matplotlib.
155155

156156
Install Dependencies
157157
====================
158+
158159
Most Python dependencies will be installed when :ref:`setting up the environment <dev-environment>`
159160
but non-Python dependencies like C++ compilers, LaTeX, and other system applications
160-
must be installed separately. For a full list, see :ref:`dependencies`.
161+
must be installed separately.
162+
163+
.. toctree::
164+
:maxdepth: 2
165+
166+
../users/installing/dependencies
167+
161168

162169
.. _development-install:
163170

@@ -195,6 +202,9 @@ config during installation ::
195202
For more information on installation and other configuration options, see the
196203
Meson Python :external+meson-python:ref:`editable installs guide <how-to-guides-editable-installs>`.
197204

205+
For a list of the other environment variables you can set before install, see :ref:`environment-variables`.
206+
207+
198208
Verify the Installation
199209
=======================
200210

doc/devel/index.rst

-6
Original file line numberDiff line numberDiff line change
@@ -88,12 +88,6 @@ Development environment
8888

8989
development_setup
9090

91-
.. toctree::
92-
:maxdepth: 1
93-
94-
dependencies
95-
../users/installing/environment_variables_faq.rst
96-
9791

9892
.. grid-item-card::
9993
:shadow: none

doc/devel/dependencies.rst renamed to doc/users/installing/dependencies.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. redirect-from: /devel/dependencies
2+
13
.. _dependencies:
24

35
************
@@ -387,7 +389,7 @@ The additional Python packages required to build the
387389

388390
The content of :file:`doc-requirements.txt` is also shown below:
389391

390-
.. include:: ../../requirements/doc/doc-requirements.txt
392+
.. include:: ../../../requirements/doc/doc-requirements.txt
391393
:literal:
392394

393395

doc/users/installing/index.rst

+29-12
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
11
.. redirect-from:: /users/installing
22

3-
============
3+
************
44
Installation
5+
************
6+
7+
Dependencies
58
============
69

10+
Mandatory dependencies should be installed automatically if you install Matplotlib using
11+
a package manager such as ``pip`` or ``conda``; therefore this list is primarily for
12+
reference and troubleshooting.
13+
14+
.. toctree::
15+
:maxdepth: 2
16+
17+
dependencies
18+
719

820
Install an official release
921
===========================
@@ -135,25 +147,30 @@ Configure build and behavior defaults
135147
=====================================
136148

137149
Aspects of the build and install process and some behaviorial defaults of the
138-
library can be configured via :ref:`environment-variables`. Default plotting
139-
appearance and behavior can be configured via the
150+
library can be configured via:
151+
152+
.. toctree::
153+
:maxdepth: 2
154+
155+
environment_variables
156+
157+
Default plotting appearance and behavior can be configured via the
140158
:ref:`rcParams file <customizing-with-matplotlibrc-files>`
141159

142160

143161

144162
.. _installing-faq:
145163

146-
==========================
147164
Frequently asked questions
148-
==========================
165+
===========================
149166

150167
Report a compilation problem
151-
============================
168+
----------------------------
152169

153170
See :ref:`reporting-problems`.
154171

155172
Matplotlib compiled fine, but nothing shows up when I use it
156-
============================================================
173+
------------------------------------------------------------
157174

158175
The first thing to try is a :ref:`clean install <clean-install>` and see if
159176
that helps. If not, the best way to test your install is by running a script,
@@ -175,7 +192,7 @@ If you are still having trouble, see :ref:`reporting-problems`.
175192
.. _clean-install:
176193

177194
How to completely remove Matplotlib
178-
===================================
195+
-----------------------------------
179196

180197
Occasionally, problems with Matplotlib can be solved with a clean
181198
installation of the package. In order to fully remove an installed Matplotlib:
@@ -187,12 +204,12 @@ installation of the package. In order to fully remove an installed Matplotlib:
187204
directory <locating-matplotlib-install>`.
188205

189206
OSX Notes
190-
=========
207+
---------
191208

192209
.. _which-python-for-osx:
193210

194211
Which python for OSX?
195-
---------------------
212+
^^^^^^^^^^^^^^^^^^^^^
196213

197214
Apple ships OSX with its own Python, in ``/usr/bin/python``, and its own copy
198215
of Matplotlib. Unfortunately, the way Apple currently installs its own copies
@@ -222,7 +239,7 @@ or Python.org Python.
222239
.. _install_osx_binaries:
223240

224241
Installing OSX binary wheels
225-
----------------------------
242+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
226243

227244
If you are using Python from https://www.python.org, Homebrew, or Macports,
228245
then you can use the standard pip installer to install Matplotlib binaries in
@@ -242,7 +259,7 @@ You might also want to install IPython or the Jupyter notebook (``python3 -m pip
242259
install ipython notebook``).
243260

244261
Checking your installation
245-
--------------------------
262+
^^^^^^^^^^^^^^^^^^^^^^^^^^
246263

247264
The new version of Matplotlib should now be on your Python "path". Check this
248265
at the Terminal.app command line::

0 commit comments

Comments
 (0)