Skip to content

Commit 9af5b10

Browse files
committed
Upate readme
1 parent 840cbaa commit 9af5b10

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,21 @@ Next ensure that the webpage builds, this can be done with
2727
python3 -m venv sc_webpage_env
2828
source sc_webpage_env/bin/activate
2929
python3 -m pip install .
30-
python3 -m jupyter book build -W ./docs
30+
cd docs
31+
jupyter book build --html --check-links --strict
3132
```
3233

33-
Inspect the webpage locally by opening `./docs/_build/html/index.html` and navigating to the appropriate page.
34+
Inspect the webpage locally by running
35+
```bash
36+
python3 -m http.server -d _build/html 8000
37+
```
38+
and opening a browser at `http://localhost:8000`.
39+
3440

3541
Before you push the changes, ensure that the text is properly formatted, run
3642

3743
```bash
38-
pre-commit
44+
pre-commit run --all
3945
```
4046

4147
Then, make corrections and commit any changes before re-running pre-commit.

0 commit comments

Comments
 (0)