Skip to content

Commit c58a1ca

Browse files
timhoffmstory645
andcommitted
Put description for dev environments in sphinx-design tabs
Tabs make it more clear that these are alternatives. Also, the reduce the overall length of the page, making it appear less intimidating. Co-authored-by: hannah <[email protected]>
1 parent 6639762 commit c58a1ca

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

doc/devel/development_setup.rst

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ You can retrieve the latest sources with the command (see
2020
git clone https://github.com/matplotlib/matplotlib.git
2121

2222
This will place the sources in a directory :file:`matplotlib` below your
23-
current working directory.
23+
current working directory. Change into this directory::
24+
25+
cd matplotlib
2426

2527
If you have the proper privileges, you can use ``git@`` instead of
2628
``https://``, which works through the ssh protocol and might be easier to use
@@ -33,45 +35,42 @@ Create a dedicated environment
3335
You should set up a dedicated environment to decouple your Matplotlib
3436
development from other Python and Matplotlib installations on your system.
3537

36-
Using virtual environments
37-
--------------------------
38-
39-
Here we use python's virtual environment `venv`_, but you may also use others
40-
such as conda.
38+
The simplest way to do this is to use either Python's virtual environment
39+
`venv`_ or `conda`_.
4140

4241
.. _venv: https://docs.python.org/3/library/venv.html
42+
.. _conda: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html
43+
44+
.. tab-set::
4345

44-
A new environment can be set up with ::
46+
.. tab-item:: venv environment
4547

46-
python -m venv <file folder location>
48+
Create a new `venv`_ environment with ::
4749

48-
and activated with one of the following::
50+
python -m venv <file folder location>
4951

50-
source <file folder location>/bin/activate # Linux/macOS
51-
<file folder location>\Scripts\activate.bat # Windows cmd.exe
52-
<file folder location>\Scripts\Activate.ps1 # Windows PowerShell
52+
and activate it with one of the following ::
5353

54-
Whenever you plan to work on Matplotlib, remember to activate the development
55-
environment in your shell.
54+
source <file folder location>/bin/activate # Linux/macOS
55+
<file folder location>\Scripts\activate.bat # Windows cmd.exe
56+
<file folder location>\Scripts\Activate.ps1 # Windows PowerShell
5657

57-
Conda dev environment
58-
---------------------
59-
After you have cloned the repo change into the matplotlib directory.
58+
.. tab-item:: conda environment
6059

61-
A new conda environment can be set-up with::
60+
Create a new `conda`_ environment with ::
6261

63-
conda env create -f environment.yml
62+
conda env create -f environment.yml
6463

65-
Note that if you have mamba installed you can replace conda with mamba in
66-
the above command.
64+
You can use ``mamba`` instead of ``conda`` in the above command if
65+
you have `mamba`_ installed.
6766

68-
To activate your environment::
67+
.. _mamba: https://mamba.readthedocs.io/en/latest/
6968

70-
conda activate mpl-dev
69+
Activate the environment using ::
7170

72-
Finish the install by the following command::
71+
conda activate mpl-dev
7372

74-
pip install -e .
73+
Remember to activate the environment whenever you start working on Matplotlib.
7574

7675
Install Matplotlib in editable mode
7776
===================================

0 commit comments

Comments
 (0)