Skip to content

Commit b383472

Browse files
authored
docs: hide deprecated options in README (#792)
Just kept them around for a bit. Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
1 parent 1b93e5b commit b383472

File tree

2 files changed

+3
-7
lines changed

2 files changed

+3
-7
lines changed

README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -152,9 +152,6 @@ print("```\n")
152152

153153
```toml
154154
[tool.scikit-build]
155-
# DEPRECATED in 0.8; use version instead.
156-
cmake.minimum-version = ""
157-
158155
# The versions of CMake to allow. If CMake is not present on the system or does
159156
# not pass this specifier, it will be downloaded via PyPI if possible. An empty
160157
# string will disable this check.
@@ -182,9 +179,6 @@ cmake.source-dir = "."
182179
# target.
183180
cmake.targets = []
184181

185-
# DEPRECATED in 0.8; use version instead.
186-
ninja.minimum-version = ""
187-
188182
# The versions of Ninja to allow. If Ninja is not present on the system or does
189183
# not pass this specifier, it will be downloaded via PyPI if possible. An empty
190184
# string will disable this check.

src/scikit_build_core/settings/skbuild_docs.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@ def __dir__() -> list[str]:
1313

1414
version = ".".join(__version__.split(".")[:2])
1515

16+
INV = {"cmake.minimum-version", "ninja.minimum-version"}
17+
1618

1719
def mk_skbuild_docs() -> str:
1820
"""
1921
Makes documentation for the skbuild model.
2022
"""
21-
items = list(mk_docs(ScikitBuildSettings))
23+
items = [x for x in mk_docs(ScikitBuildSettings) if x.name not in INV]
2224
for item in items:
2325
if item.name == "minimum-version":
2426
item.default = f'"{version}" # current version'

0 commit comments

Comments
 (0)