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: CONTRIBUTING.md
+16-2
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,14 @@ Use [conda](https://docs.conda.io/) to set up a build environment:
27
27
conda env update -f ../ci/environment.yml
28
28
```
29
29
30
-
This will create or update the dev environment (`pythia`).
30
+
This will create the dev environment (`pythia`). If you have previously created the environment, running this command will add any new packages that have since been added to the `environment.yml` file.
31
+
32
+
It's a good idea to also keep the *versions* of each package in the `pythia` environment up to date by doing:
33
+
34
+
```bash
35
+
conda activate pythia
36
+
conda update --all
37
+
```
31
38
32
39
#### Install `pre-commit` hooks
33
40
@@ -52,6 +59,8 @@ Build the site locally using Sphinx (which you just installed in the `pythia` en
52
59
make html
53
60
```
54
61
62
+
If this step fails and you have not updated your conda environment recently, try updating with `conda env update -f ../ci/environment.yml` and `conda update --all` as described above.
63
+
55
64
The newly rendered site is now available in `portal/_build/html/index.html`.
56
65
Open with your web browser, or from the terminal:
57
66
@@ -78,7 +87,12 @@ When you're done, you can deactivate the dedicated build environment with
78
87
conda deactivate
79
88
```
80
89
81
-
You can re-activate the `pythia` conda environment at any time with `conda activate pythia`.
90
+
You can re-activate the `pythia` conda environment at any time with `conda activate pythia`. You may also want to update each package in the activated environment to their latest versions by doing
0 commit comments