You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,13 +9,16 @@ This repository contains Coding Guidelines for writing Safety Critical Rust, dev
9
9
10
10
The Safety-Critical Rust Coding Guidelines website uses `Sphinx` and `Sphinx-Needs` to build a rendered version of the coding guidelines, and `uv` to install and manage Python dependencies (including Sphinx itself). To simplify building the rendered version, we created a script called `make.py` that takes care of invoking Sphinx with the right flags.
11
11
12
-
- On Linux and macOS, build the rendered version by running `./make.py`.
13
-
- On Windows systems, build the rendered version by running `uv run make.py`.
12
+
Build the rendered version by running:
13
+
14
+
```shell
15
+
uv run --frozen make.py
16
+
```
14
17
15
18
By default, Sphinx uses incremental rebuilds to generate the content that
16
19
changed since the last invocation. If you notice a problem with incremental
17
20
rebuilds, pass the `-c` flag to clear the existing artifacts before
18
-
building `./make.py -c`.
21
+
building `uv run --frozen make.py -c`.
19
22
20
23
The following output is generated:
21
24
@@ -30,7 +33,7 @@ The following output is generated:
30
33
If you're working without internet access or want to avoid reaching out to remote resources, you can pass the `--offline` flag:
31
34
32
35
```shell
33
-
./make.py --offline
36
+
uv run --frozen make.py --offline
34
37
```
35
38
36
39
This prevents the build system from attempting to fetch remote resources, such as updates to the specification. Use this flag when you need reproducible or air-gapped builds.
@@ -48,7 +51,7 @@ The file is checked against the current live version of the specification, which
48
51
If you run into this while developing a coding guideline, you may ignore this error by running the build with:
Copy file name to clipboardExpand all lines: exts/coding_guidelines/fls_checks.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ def check_fls(app, env):
49
49
error_message+="\n\tuv run python scripts/fls_audit.py"
50
50
error_message+="\nIf the audit tool reports missing baseline metadata, provide --baseline-fls-commit/--current-fls-commit or set GITHUB_TOKEN when using deployment offsets."
51
51
error_message+="\nOnce resolved, you may run the following to update the local spec lock file:"
0 commit comments