Skip to content

update rtd with generated environment #355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update rtd with generated environment #355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,29 @@ cd docs
make html
```

#### Updating the ReadTheDocs env

Due to some heavyweight dependencies, the `conda` environment is pre-solved and
checked in, based on `.binder/environment.yml`. To update this environment,
install `conda-lock` with `pip`:

```bash
pip install .[lock]
```

or `conda`:

```bash
conda install -c conda-forge 'conda-lock>=0.8.0'
```

And then:

```bash
cd docs
python update_env.py
```

### Explore the examples

```bash
Expand Down
Loading