Skip to content

Commit 508cbd5

Browse files
committed
chore: prepare a bit more for 0.3.0
Signed-off-by: Henry Schreiner <[email protected]>
1 parent b7ac3f3 commit 508cbd5

File tree

3 files changed

+20
-6
lines changed

3 files changed

+20
-6
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Some known missing features that will be developed soon:
4848

4949
- No support for other targets besides install
5050
- Wheels are not fully reproducible yet
51+
- Several editable mode caveats (mentioned in the docs)
5152

5253
Other backends are also planned:
5354

docs/changelog.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,32 @@ Features:
2424
- Support modules/prefix dirs by @henryiii in #255
2525
- Add `get_requires_for_dynamic_metadata` by @henryiii in #235
2626
- Make setuptools wrapper more generic by @henryiii in #225
27-
- Experimental support for editable installs by @henryiii in #212
27+
- Experimental support for editable installs by @henryiii in #212, #268, and
28+
#271
2829

2930
Fixes:
3031

3132
- CMake 3.26.0 (exactly) needs the backport too by @henryiii in #238
3233
- Add python library artifact for better Windows cross compiling by @henryiii in
3334
#263
3435
- Include 3.26.1 SABI fix by @henryiii in #227
35-
- Restructure get_requires & fix some ninja paths by @henryiii in #250
36+
- Restructure `get_requires` & fix some ninja paths by @henryiii in #250
3637
- Support script rewriting by @henryiii in #254
3738
- Version not a string (typing updates) by @henryiii in #231
3839
- `{wheel_tag}` was not working by @henryiii in #262
40+
- `CMAKE_PREFIX_DIR` and `CMAKE_MODULE_DIR` are passed in the init cache file to
41+
remove a unused variable warning by @henryiii in #272
42+
- Support color printouts without Rich (pip requires `FORCE_COLOR`) by @henryiii
43+
in #266
3944

4045
Other things:
4146

42-
- Add fortran testing and CI by @henryiii in #86
43-
- Avoid interent usage in non-isolated testing by @henryiii in #247
44-
- Add an sdist checker & fix contents by @henryiii in #253
47+
- Add Fortran testing and CI by @henryiii in #86
48+
- Avoid internet usage in non-isolated testing by @henryiii in #247
49+
- Add an SDist checker & fix contents by @henryiii in #253
4550
- Add more setuptools types by @henryiii in #233
4651
- Add FedoraProject rpm spec file by @LecrisUT in #201 and #241
52+
- Better coverage handling by @henryiii in #270
4753

4854
## Version 0.2.2
4955

docs/configuration.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -444,14 +444,21 @@ configuration. Recommendations:
444444
it).
445445
- Select a `build-dir` when using editable installs, especially if you also
446446
enable automatic rebuilds.
447-
- Resources (via `importlib.resources`) are not properly supported (yet).
448447
- You need to reinstall to pick up new files.
449448

449+
Known limitations:
450+
451+
- Resources (via `importlib.resources`) are not properly supported (yet).
452+
450453
```console
451454
# Very expiremental rebuild on initial import feature
452455
$ pip install --no-build-isolation --config-settings=editiable.rebuild=true -ve.
453456
```
454457

458+
Due to the length of this line already being long, you do not need to set the
459+
`experimental` setting to use editable installs, but please consider them
460+
experimental and subject to change.
461+
455462
You can disable the verbose rebuild output with `editable.verbose=false` if you
456463
want. (Also available as the `SKBUILD_EDITABLE_VERBOSE` envvar when importing;
457464
this will override if non-empty, and `"0"` will disable verbose output).

0 commit comments

Comments
 (0)