Skip to content

Commit

Permalink
Merge pull request #1 from ARCTraining/update-readme
Browse files Browse the repository at this point in the history
General update to environment configuration
  • Loading branch information
Sparrow0hawk authored May 23, 2022
2 parents c8b62fb + 7f0bcd2 commit 645e2d6
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/test-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@ on:
# This job installs dependencies and builds the book
jobs:
deploy-book:
runs-on: ubuntu-latest
runs-on: ${{ matrix.os }}
strategy:
# test build on multiple OS
matrix:
os: [macos-latest, windows-latest, ubuntu-latest]
steps:
- uses: actions/checkout@v2
- uses: conda-incubator/setup-miniconda@v2
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ $ jupyter-book build book/
```
### Windows

An important note is that the JupyterBook project does not currently support Windows ([see here for more](https://jupyterbook.org/advanced/advanced.html#working-on-windows)).
Jupyterbook now supports [Windows](https://jupyterbook.org/en/stable/advanced/windows.html) although the steps for configuring a development environment using Vagrant are available below:

#### Set up a development environment using Vagrant

To aid with this we have created a `Vagrantfile` that can allow Windows users who have a virtualisation provider installed (such as [VirtualBox](https://www.virtualbox.org/)) and [Vagrant](https://www.vagrantup.com/) installed to create a headless virtual Linux machine that will build the jupyter book. You can do this with the following steps once you've installed a virtualisation provider and vagrant:
```
Expand Down
11 changes: 3 additions & 8 deletions environment.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
name: arcdocs-jb
channels:
- conda-forge
- bioconda
- defaults
dependencies:
- python=3.8
- pandas=1.0.5
- jupyterlab
- matplotlib
- python=3.7.6
- jinja2=3.0.3
- pip=20
- pip:
- jupyter-book
- ghp-import
- jupyter-book==0.9.1

0 comments on commit 645e2d6

Please sign in to comment.