Skip to content

docs: hide deprecated options in README #792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 2, 2024
Merged

docs: hide deprecated options in README #792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,9 +152,6 @@ print("```\n")

```toml
[tool.scikit-build]
# DEPRECATED in 0.8; use version instead.
cmake.minimum-version = ""

# The versions of CMake to allow. If CMake is not present on the system or does
# not pass this specifier, it will be downloaded via PyPI if possible. An empty
# string will disable this check.
Expand Down Expand Up @@ -182,9 +179,6 @@ cmake.source-dir = "."
# target.
cmake.targets = []

# DEPRECATED in 0.8; use version instead.
ninja.minimum-version = ""

# The versions of Ninja to allow. If Ninja is not present on the system or does
# not pass this specifier, it will be downloaded via PyPI if possible. An empty
# string will disable this check.
Expand Down
4 changes: 3 additions & 1 deletion src/scikit_build_core/settings/skbuild_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@

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

INV = {"cmake.minimum-version", "ninja.minimum-version"}


def mk_skbuild_docs() -> str:
"""
Makes documentation for the skbuild model.
"""
items = list(mk_docs(ScikitBuildSettings))
items = [x for x in mk_docs(ScikitBuildSettings) if x.name not in INV]

Check warning on line 23 in src/scikit_build_core/settings/skbuild_docs.py

View check run for this annotation

Codecov / codecov/patch

src/scikit_build_core/settings/skbuild_docs.py#L23 

Added line #L23 was not covered by tests
for item in items:
if item.name == "minimum-version":
item.default = f'"{version}" # current version'
Expand Down
Loading