From 08321bb3327c66a6c6587575ea3176b856e6e85f Mon Sep 17 00:00:00 2001 From: notchia Date: Tue, 31 Oct 2023 04:50:38 -0400 Subject: [PATCH 1/2] clarify that requirements must be installed during venv setup step --- doc/devel/development_setup.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 5827fe929d61..d1791ddc4b11 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -131,9 +131,13 @@ The simplest way to do this is to use either Python's virtual environment On some systems, you may need to type ``python3`` instead of ``python``. For a discussion of the technical reasons, see `PEP-394 `_. + Install the development dependencies :: + + pip install -r requirements/dev/dev-requirements.txt + .. tab-item:: conda environment - Create a new `conda`_ environment with :: + Create a new `conda`_ environment with the development dependencies installed :: conda env create -f environment.yml From 10a03fc41da74e3ff7c74701c765e417f5226ea0 Mon Sep 17 00:00:00 2001 From: notchia Date: Tue, 31 Oct 2023 06:03:56 -0400 Subject: [PATCH 2/2] use same grammar as original doc --- doc/devel/development_setup.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index d1791ddc4b11..57c063605c47 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -131,13 +131,13 @@ The simplest way to do this is to use either Python's virtual environment On some systems, you may need to type ``python3`` instead of ``python``. For a discussion of the technical reasons, see `PEP-394 `_. - Install the development dependencies :: + Install the Python dependencies with :: pip install -r requirements/dev/dev-requirements.txt .. tab-item:: conda environment - Create a new `conda`_ environment with the development dependencies installed :: + Create a new `conda`_ environment and install the Python dependencies with :: conda env create -f environment.yml