Skip to content

Commit a877ff6

Browse files
authored
Update conda docs (#164)
* Add instructions for conda update --all * Better wording * Bit more clarity * Add a bit more detail as suggested by @clyne
1 parent 6a63901 commit a877ff6

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

CONTRIBUTING.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,14 @@ Use [conda](https://docs.conda.io/) to set up a build environment:
2727
conda env update -f ../ci/environment.yml
2828
```
2929

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+
```
3138

3239
#### Install `pre-commit` hooks
3340

@@ -52,6 +59,8 @@ Build the site locally using Sphinx (which you just installed in the `pythia` en
5259
make html
5360
```
5461

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+
5564
The newly rendered site is now available in `portal/_build/html/index.html`.
5665
Open with your web browser, or from the terminal:
5766

@@ -78,7 +87,12 @@ When you're done, you can deactivate the dedicated build environment with
7887
conda deactivate
7988
```
8089

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
91+
92+
```bash
93+
conda activate pythia
94+
conda update --all
95+
```
8296

8397
### To view the Read the Docs autobuild
8498

0 commit comments

Comments
 (0)