Skip to content

Commit 2189080

Browse files
committed
update contributing guide
1 parent ef78ac7 commit 2189080

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

appendix/how-to-contribute.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,23 +48,19 @@ To build the book locally, run the following:
4848

4949
```bash
5050
conda activate pythia-book-dev
51-
jupyter-book build .
51+
myst start --execute
5252
```
5353

54-
Finally, you can view the book by opening the file `_build/html/index.html` with your favorite web browser. On most platforms you can simply run:
55-
56-
```bash
57-
open _build/html/index.html
58-
```
54+
Finally, you can view the book by opening the localhost link that should be generated in your terminal.
5955

6056
### Keeping your dev environment up to date
6157

62-
It's good practice to update the packages in your `pythia-book-dev` conda environment frequently to their latest versions, especially if it's been a while since you used it. If the `jupyter-book build .` command above generates error messages, that is a good indication that your conda environment may be out of date.
58+
It's good practice to update the packages in your `pythia-book-dev` conda environment frequently to their latest versions, especially if it's been a while since you used it. If the `myst start --execute` command above generates error messages, that is a good indication that your conda environment may be out of date.
6359

6460
To update all packages in the currently activated environment to their latest versions, do this:
6561

6662
```bash
6763
conda update --all
6864
```
6965

70-
[pythia contributor's guide]: https://projectpythia.org/contributing.html
66+
[pythia contributor's guide]: https://projectpythia.org/pythia-contributing.html

0 commit comments

Comments
 (0)