Skip to content

Commit 7e5e7e6

Browse files
committed
use not -t gen to generate doc
1 parent c71ce47 commit 7e5e7e6

File tree

3 files changed

+14
-11
lines changed

3 files changed

+14
-11
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,9 @@ editable.verbose = true
232232
# Rebuild the project when the package is imported.
233233
editable.rebuild = false
234234

235+
# Build directory to use when :confval:`editable.mode` is ``inplace``.
236+
editable.build-dir = ""
237+
235238
# Extra args to pass directly to the builder in the build step.
236239
build.tool-args = []
237240

@@ -281,7 +284,7 @@ strict-config = true
281284
experimental = false
282285

283286
# If set, this will provide a method for backward compatibility.
284-
minimum-version = "0.11" # current version
287+
minimum-version = "0.1" # current version
285288

286289
# The CMake build directory. Defaults to a unique temporary directory.
287290
build-dir = ""

docs/reference/configs.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,15 @@ print(mk_skbuild_docs())
247247

248248
## editable
249249

250+
```{eval-rst}
251+
.. confval:: editable.build-dir
252+
:type: ``str``
253+
254+
Build directory to use when :confval:`editable.mode` is ``inplace``.
255+
256+
If empty, the project source directory is used (the historical behaviour).
257+
```
258+
250259
```{eval-rst}
251260
.. confval:: editable.mode
252261
:type: ``"redirect" | "inplace"``
@@ -271,15 +280,6 @@ print(mk_skbuild_docs())
271280
:default: true
272281
273282
Turn on verbose output for the editable mode rebuilds.
274-
275-
```{eval-rst}
276-
.. confval:: editable.build-dir
277-
:type: ``str``
278-
:default: ""
279-
280-
Build directory to use when ``editable.mode`` is ``"inplace"``. If empty, the project
281-
source directory is used.
282-
```
283283
```
284284

285285
## generate[]

src/scikit_build_core/resources/scikit-build.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@
278278
"build-dir": {
279279
"type": "string",
280280
"default": "",
281-
"description": "Build directory to use when ``editable.mode`` is \"inplace\". If empty, the project source directory is used."
281+
"description": "Build directory to use when :confval:`editable.mode` is ``inplace``."
282282
}
283283
}
284284
},

0 commit comments

Comments
 (0)