Skip to content

Commit 43fadc3

Browse files
authored
docs: add more about downstream (#347)
Adding some docs about downstream usage. --------- Signed-off-by: Henry Schreiner <[email protected]>
1 parent 8d87f6e commit 43fadc3

File tree

3 files changed

+19
-2
lines changed

3 files changed

+19
-2
lines changed

.github/CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
# Testing a project with a branch / main
2+
3+
If you are testing a downstream project, you can use a branch of
4+
scikit-build-core like this:
5+
6+
```toml
7+
[build-system]
8+
requires = ["scikit-build-core @ git+https://github.com/scikit-build/scikit-build-core@main"]
9+
build-backend = "scikit_build_core.build"
10+
```
11+
12+
Or you can build your project from the scikit-build-core source with nox:
13+
14+
```bash
15+
nox -s downstream -- https://github.com/...
16+
```
17+
118
# Setting up for development
219

320
See the [Scikit-HEP Developer introduction][skhep-dev-intro] for a detailed

docs/cmakelists.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ If you are making a Limited ABI / Stable API package, you'll need the
2626
`Development.SABIModule` component instead. You can use the
2727
`SKBUILD_LIMITED_API` variable to check to see if it was requested.
2828

29-
If you want to use the old, deprecated FindPythnoInterp and FindPythonLibs
29+
If you want to use the old, deprecated FindPythonInterp and FindPythonLibs
3030
instead, you can. Though it should be noted that FindPythonLibs requires a trick
3131
to make it work properly if a Python library is not preset (like in manylinux):
3232
you have to set `PYTHON_LIBRARY` to something (doesn't matter what) to make it

noxfile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ def downstream(session: nox.Session) -> None:
154154
else:
155155
import tomllib
156156

157-
parser = argparse.ArgumentParser()
157+
parser = argparse.ArgumentParser(prog=f"{Path(sys.argv[0]).name} -s downstream")
158158
parser.add_argument("project", help="A project to build")
159159
parser.add_argument("--subdir", help="A subdirectory to build")
160160
args, remaining = parser.parse_known_args(session.posargs)

0 commit comments

Comments
 (0)