@@ -250,37 +250,38 @@ development environment that must be installed before a compiler can be installe
250
250
You may also need to install headers for various libraries used in the compiled extension
251
251
source files.
252
252
253
+ .. _dev-compiler :
253
254
.. tab-set ::
254
255
255
- .. tab-item :: Linux
256
+ .. tab-item :: Linux
256
257
257
- On some Linux systems, you can install a meta-build package. For example,
258
- on Ubuntu ``apt install build-essential ``
258
+ On some Linux systems, you can install a meta-build package. For example,
259
+ on Ubuntu ``apt install build-essential ``
259
260
260
- Otherwise, use the system distribution's package manager to install
261
- :ref: `gcc <compiler-table >`.
261
+ Otherwise, use the system distribution's package manager to install
262
+ :ref: `gcc <compiler-table >`.
262
263
263
- .. tab-item :: macOS
264
+ .. tab-item :: macOS
264
265
265
- Install `Xcode <https://developer.apple.com/xcode/ >`_ for Apple platform development.
266
+ Install `Xcode <https://developer.apple.com/xcode/ >`_ for Apple platform development.
266
267
267
- .. tab-item :: Windows
268
+ .. tab-item :: Windows
268
269
269
- Install `Visual Studio Build Tools <https://visualstudio.microsoft.com/downloads/?q=build+tools >`_
270
+ Install `Visual Studio Build Tools <https://visualstudio.microsoft.com/downloads/?q=build+tools >`_
270
271
271
- Make sure "Desktop development with C++" is selected, and that the latest MSVC,
272
- "C++ CMake tools for Windows," and a Windows SDK compatible with your version
273
- of Windows are selected and installed. They should be selected by default under
274
- the "Optional" subheading, but are required to build Matplotlib from source.
272
+ Make sure "Desktop development with C++" is selected, and that the latest MSVC,
273
+ "C++ CMake tools for Windows," and a Windows SDK compatible with your version
274
+ of Windows are selected and installed. They should be selected by default under
275
+ the "Optional" subheading, but are required to build Matplotlib from source.
275
276
276
- Alternatively, you can install a Linux-like environment such as `CygWin <https://www.cygwin.com/ >`_
277
- or `Windows Subsystem for Linux <https://learn.microsoft.com/en-us/windows/wsl/install >`_.
278
- If using `MinGW-64 <https://www.mingw-w64.org/ >`_, we require **v6 ** of the
279
- ```Mingw-w64-x86_64-headers ``.
277
+ Alternatively, you can install a Linux-like environment such as `CygWin <https://www.cygwin.com/ >`_
278
+ or `Windows Subsystem for Linux <https://learn.microsoft.com/en-us/windows/wsl/install >`_.
279
+ If using `MinGW-64 <https://www.mingw-w64.org/ >`_, we require **v6 ** of the
280
+ ```Mingw-w64-x86_64-headers ``.
280
281
281
282
282
- We highly recommend that you install a compiler using your platform tool, i.e.,
283
- Xcode, VS Code or Linux package manager. Choose **one ** compiler from this list:
283
+ We highly recommend that you install a compiler using your platform tool, i.e., Xcode,
284
+ VS Code or Linux package manager. Choose **one ** compiler from this list:
284
285
285
286
.. _compiler-table :
286
287
@@ -307,7 +308,6 @@ Xcode, VS Code or Linux package manager. Choose **one** compiler from this list:
307
308
- `Visual Studio 2019 C++ <https://docs.microsoft.com/en-us/cpp/overview/visual-cpp-language-conformance?view=msvc-160 >`_
308
309
309
310
310
-
311
311
.. _test-dependencies :
312
312
313
313
Test dependencies
@@ -327,8 +327,11 @@ Optional
327
327
In addition to all of the optional dependencies on the main library, for
328
328
testing the following will be used if they are installed.
329
329
330
- - Ghostscript _ (>= 9.0, to render PDF files)
331
- - Inkscape _ (to render SVG files)
330
+ Python
331
+ ^^^^^^
332
+ These packages are installed when :ref: `creating a virtual environment <dev-environment >`,
333
+ otherwise they must be installed manually:
334
+
332
335
- nbformat _ and nbconvert _ used to test the notebook backend
333
336
- pandas _ used to test compatibility with Pandas
334
337
- pikepdf _ used in some tests for the pgf and pdf backends
@@ -340,9 +343,14 @@ testing the following will be used if they are installed.
340
343
- pytest-xvfb _ to run tests without windows popping up (Linux)
341
344
- pytz _ used to test pytz int
342
345
- sphinx _ used to test our sphinx extensions
346
+ - xarray _ used to test compatibility with xarray
347
+
348
+ External tools
349
+ ^^^^^^^^^^^^^^
350
+ - Ghostscript _ (>= 9.0, to render PDF files)
351
+ - Inkscape _ (to render SVG files)
343
352
- `WenQuanYi Zen Hei `_ and `Noto Sans CJK `_ fonts for testing font fallback and
344
353
non-Western fonts
345
- - xarray _ used to test compatibility with xarray
346
354
347
355
If any of these dependencies are not discovered, then the tests that rely on
348
356
them will be skipped by pytest.
@@ -355,6 +363,7 @@ them will be skipped by pytest.
355
363
356
364
.. _Ghostscript : https://ghostscript.com/
357
365
.. _Inkscape : https://inkscape.org
366
+ .. _WenQuanYi Zen Hei : http://wenq.org/en/
358
367
.. _flake8 : https://pypi.org/project/flake8/
359
368
.. _nbconvert : https://pypi.org/project/nbconvert/
360
369
.. _nbformat : https://pypi.org/project/nbformat/
@@ -369,7 +378,6 @@ them will be skipped by pytest.
369
378
.. _pytest-xvfb : https://pypi.org/project/pytest-xvfb/
370
379
.. _pytest : http://doc.pytest.org/en/latest/
371
380
.. _sphinx : https://pypi.org/project/Sphinx/
372
- .. _WenQuanYi Zen Hei : http://wenq.org/en/
373
381
.. _Noto Sans CJK : https://fonts.google.com/noto/use
374
382
.. _xarray : https://pypi.org/project/xarray/
375
383
@@ -394,30 +402,30 @@ The content of :file:`doc-requirements.txt` is also shown below:
394
402
:literal:
395
403
396
404
405
+ .. _doc-dependencies-external :
406
+
397
407
External tools
398
408
--------------
399
409
400
- The documentation requires LaTeX and Graphviz. These are not
401
- Python packages and must be installed separately.
402
-
403
410
Required
404
411
^^^^^^^^
412
+ The documentation requires LaTeX and Graphviz. These are not
413
+ Python packages and must be installed separately.
405
414
406
415
* `Graphviz <http://www.graphviz.org/download >`_
407
416
* a minimal working LaTeX distribution, e.g. `TeX Live <https://www.tug.org/texlive/ >`_ or
408
417
`MikTeX <https://miktex.org/ >`_
409
418
410
419
The following LaTeX packages:
411
420
412
- * `dvipng <https://ctan.org/pkg/dvipng >`_
413
- * `underscore <https://ctan.org/pkg/underscore >`_
414
- * `cm-super <https://ctan.org/pkg/cm-super >`_
415
- * ``collection-fontsrecommended ``
421
+ * `dvipng <https://ctan.org/pkg/dvipng >`_
422
+ * `underscore <https://ctan.org/pkg/underscore >`_
423
+ * `cm-super <https://ctan.org/pkg/cm-super >`_
424
+ * ``collection-fontsrecommended ``
416
425
417
426
The complete version of many LaTex distribution installers, e.g.
418
427
"texlive-full" or "texlive-all", will often automatically include these packages.
419
428
420
-
421
429
Optional
422
430
^^^^^^^^
423
431
0 commit comments