@@ -386,14 +386,14 @@ compiler just like building for :ref:`Unix <unix-compiling>` as well as:
386
386
1. A C compiler that can target WebAssembly (for example, `WASI SDK `_)
387
387
2. A WASI host/runtime (for example, Wasmtime _)
388
388
389
- All of this is provided in the :ref: `devcontainer <using-codespaces >`. You can
389
+ All of this is provided in the :ref: `devcontainer <using-a-container >`. You can
390
390
also use what's installed in the container as a reference of what versions of
391
391
these tools are known to work.
392
392
393
393
.. note ::
394
394
395
- CPython has only been verified with the above tools for WASI. Using
396
- other compilers, hosts, or WASI versions *should * work, but the above tools
395
+ CPython has only been verified with the certain tools for WASI. Using
396
+ other compilers, hosts, or WASI versions *should * work, but the tools
397
397
and their versions specified in the container are tested via a
398
398
:ref: `buildbot <buildbots >`.
399
399
@@ -1124,17 +1124,26 @@ every rule.
1124
1124
.. c_directory_structure_end
1125
1125
1126
1126
1127
+ .. _using-a-container :
1128
+
1129
+ Using a container
1130
+ =================
1131
+
1132
+ There are various ways to use a container to build CPython without installing
1133
+ additional tools on your machine. All approaches use the container defined in
1134
+ the `cpython-devcontainers repo `_ in some way.
1135
+
1127
1136
.. _using-codespaces :
1128
1137
1129
1138
Contribute using GitHub Codespaces
1130
- ==================================
1139
+ ----------------------------------
1131
1140
1132
1141
.. c_codespaces_start
1133
1142
1134
1143
.. _codespaces-whats-codespaces :
1135
1144
1136
1145
What is GitHub Codespaces?
1137
- --------------------------
1146
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^
1138
1147
1139
1148
If you'd like to start contributing to CPython without needing to set up a local
1140
1149
developer environment, you can use
@@ -1153,7 +1162,7 @@ you'd prefer to use that directly.
1153
1162
.. _codespaces-create-a-codespace :
1154
1163
1155
1164
Create a CPython codespace
1156
- --------------------------
1165
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^
1157
1166
1158
1167
Here are the basic steps needed to contribute a pull request using Codespaces.
1159
1168
You first need to navigate to the
@@ -1182,7 +1191,7 @@ up from where you left off!
1182
1191
.. _codespaces-use-locally :
1183
1192
1184
1193
Use Codespaces locally
1185
- ----------------------
1194
+ ^^^^^^^^^^^^^^^^^^^^^^
1186
1195
1187
1196
On the bottom left side of the codespace screen you will see a green or grey
1188
1197
square that says :guilabel: `Codespaces `. You can click this for additional
@@ -1191,10 +1200,12 @@ select the option ``Open in VS Code``. You will still be working on the remote
1191
1200
codespace instance, thus using the remote instance's compute power. The compute
1192
1201
power may be a much higher spec than your local machine which can be helpful.
1193
1202
1203
+ .. c_codespaces_end
1204
+
1194
1205
.. _devcontainer-directly :
1195
1206
1196
1207
Using the dev container directly
1197
- ================================
1208
+ --------------------------------
1198
1209
1199
1210
If you want more control over the environment, or to work offline,
1200
1211
you can use the same container used in
@@ -1208,7 +1219,7 @@ installed.
1208
1219
.. _devcontainer-image :
1209
1220
1210
1221
Using the pre-built container image
1211
- -----------------------------------
1222
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1212
1223
1213
1224
`Dev container images <https://github.com/python/cpython-devcontainers/pkgs/container/devcontainer >`__
1214
1225
are available from the
@@ -1232,10 +1243,10 @@ to remove caches and build output generated for your host OS.
1232
1243
.. _devcontainer-build :
1233
1244
1234
1245
Building yourself
1235
- -----------------
1246
+ ^^^^^^^^^^^^^^^^^
1236
1247
1237
1248
If you prefer, you can build the container image yourself. In a clone of the
1238
- `cpython-devcontainers repo < https://github.com/python/cpython-devcontainers > `_,
1249
+ `cpython-devcontainers repo `_,
1239
1250
build the container and name it ``cpython-dev ``:
1240
1251
1241
1252
.. code-block :: bash
@@ -1262,7 +1273,6 @@ in a clone of the CPython repository.
1262
1273
The same caveats outlined above when running from a container image from GHCR
1263
1274
also apply here.
1264
1275
1265
- .. c_codespaces_end
1266
-
1267
1276
1277
+ .. _cpython-devcontainers repo : https://github.com/python/cpython-devcontainers
1268
1278
.. include :: ../links.rst
0 commit comments