@@ -34,24 +34,31 @@ repository, you should first fork this repository by *clicking* the
34
34
This creates a copy of the code under your account on the GitHub server. See `the GitHub
35
35
documentation <https://docs.github.com/get-started/quickstart/fork-a-repo> `__ for more details.
36
36
37
- Decide whether to work locally or in GitHub Codespaces
38
- ======================================================
37
+ Set up development environment
38
+ ==============================
39
39
40
40
You can either work locally on your machine, or online in
41
41
`GitHub Codespaces <github-codespaces _>`_, a cloud-based in-browser development
42
- environment. If you are making a one-off, relatively simple change then
43
- working in GitHub Codespaces can be a good option because most of the setting
44
- up is done for you and you can skip the next few sections! If you are making
45
- extensive or frequent contributions to Matplotlib then it is probably worth
46
- taking the time to set up on your local machine: As well as having the
47
- convenience of your local familiar tools, you will not need to worry about
48
- Codespace's monthly usage limits.
42
+ environment.
43
+
44
+
45
+ :local: If you are making extensive or frequent contributions to Matplotlib then it
46
+ is probably worth taking the time to set up on your local machine: As well as
47
+ having the convenience of your local familiar tools, you will not need to worry
48
+ about Codespace's monthly usage limits.
49
+
50
+ :codespaces: If you are making a one-off, relatively simple, change then working in
51
+ GitHub Codespaces can be a good option because most of the setting
52
+ up is done for you and you can skip the next few sections.
49
53
50
54
If you want to use Codespaces, skip to :ref: `development-codespaces `,
51
55
otherwise, continue with the next section.
52
56
53
- Retrieve the latest version of the code
54
- =======================================
57
+ Create local environment
58
+ ------------------------
59
+
60
+ Get most recent code
61
+ ^^^^^^^^^^^^^^^^^^^^
55
62
56
63
Now that your fork of the repository lives under your GitHub username, you can
57
64
retrieve the most recent version of the source code with one of the following
@@ -122,8 +129,9 @@ code, as described in :ref:`development-workflow`.
122
129
123
130
.. _dev-environment :
124
131
125
- Create a dedicated python environment
126
- =====================================
132
+ Create a dedicated environment
133
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
134
+
127
135
You should set up a dedicated environment to decouple your Matplotlib
128
136
development from other Python and Matplotlib installations on your system.
129
137
@@ -142,11 +150,27 @@ setup.
142
150
143
151
python -m venv <file folder location>
144
152
145
- and activate it with one of the following ::
153
+ and activate it with one of the following :
154
+
155
+ .. tab-set ::
156
+
157
+ .. tab-item :: Linux and macOS
158
+
159
+ .. code-block :: bash
160
+
161
+ source < file folder location> /bin/activate # Linux/macOS
162
+
163
+ .. tab-item :: Windows cmd.exe
164
+
165
+ .. code-block :: bat
166
+
167
+ < file folder location> \Scripts\activate.bat
168
+
169
+ .. tab-item :: Windows PowerShell
170
+
171
+ .. code-block :: ps1con
146
172
147
- source <file folder location>/bin/activate # Linux/macOS
148
- <file folder location>\Scripts\activate.bat # Windows cmd.exe
149
- <file folder location>\Scripts\Activate.ps1 # Windows PowerShell
173
+ <file folder location>\Scripts\Activate.ps1
150
174
151
175
On some systems, you may need to type ``python3 `` instead of ``python ``.
152
176
For a discussion of the technical reasons, see `PEP-394 <https://peps.python.org/pep-0394 >`_.
@@ -176,7 +200,7 @@ setup.
176
200
177
201
178
202
Install external dependencies
179
- =============================
203
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
180
204
181
205
Python dependencies were installed as part of :ref: `setting up the environment <dev-environment >`.
182
206
Additionally, the following non-Python dependencies must also be installed locally:
@@ -192,8 +216,8 @@ need to be installed when working in codespaces.
192
216
193
217
.. _development-codespaces :
194
218
195
- :octicon: `codespaces ` Create a GitHub Codespace
196
- ===============================================
219
+ Create GitHub Codespace :octicon: `codespaces `
220
+ ---------------------------------------------
197
221
198
222
`GitHub Codespaces <github-codespaces _>`_ is a cloud-based
199
223
in-browser development environment that comes with the appropriate setup to
0 commit comments