From 9b772256b020d77fb873912a7889097a56c498ff Mon Sep 17 00:00:00 2001 From: Jimmy Shah Date: Tue, 5 Nov 2024 12:46:25 -0500 Subject: [PATCH] Update install to note installation for ninja library --- doc/devel/development_setup.rst | 2 +- doc/install/dependencies.rst | 19 ++++++++++++++----- 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index baf63a825307..45b95e48e7ff 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -207,7 +207,7 @@ Additionally, the following non-Python dependencies must also be installed local .. rst-class:: checklist -* :ref:`c++ compiler` +* :ref:`compile-build-dependencies` * :ref:`external tools used by the documentation build ` diff --git a/doc/install/dependencies.rst b/doc/install/dependencies.rst index f01635d12367..1e1837512409 100644 --- a/doc/install/dependencies.rst +++ b/doc/install/dependencies.rst @@ -229,9 +229,6 @@ means that the dependencies must be explicitly installed, either by :ref:`creati (recommended) or by manually installing the following packages: - `meson-python `_ (>= 0.13.1). -- `ninja `_ (>= 1.8.2). This may be available in your package - manager or bundled with Meson, but may be installed via ``pip`` if otherwise not - available. - `PyBind11 `_ (>= 2.13.2). Used to connect C/C++ code with Python. - `setuptools_scm `_ (>= 7). Used to @@ -240,10 +237,22 @@ means that the dependencies must be explicitly installed, either by :ref:`creati - `NumPy `_ (>= 1.22). Also a runtime dependency. +.. _compile-build-dependencies: + +Compilers and external build tools +---------------------------------- + +When setting up a virtual environment for development, `ninja `_ +(>= 1.8.2) may need to be installed separately. This may be available +as a `pre-built binary `_ or from a +`package manager `_ +or bundled with Meson. Ninja may also be installed via ``pip`` if otherwise not +available. + .. _compile-dependencies: -Compiled extensions -------------------- +Compilers +^^^^^^^^^ Matplotlib requires a C++ compiler that supports C++17, and each platform has a development environment that must be installed before a compiler can be installed.