Merge pull request #364 from abkfenris/pixi

Use pixi to manage environment

Author: abkfenris

.github/workflows/check_sphinx_build.yml

@@ -18,21 +18,20 @@ jobs:
         with:
           submodules: true
 
-      - name: Install Conda environment from environment.yml
-        uses: mamba-org/setup-micromamba@0dea6379afdaffa5d528b3d1dabc45da37f443fc  # v2.0.4
+      - uses: prefix-dev/setup-pixi@v0.8.14
         with:
-          environment-file: environment.yml
-          cache-environment: true
+          pixi-version: v0.51.0
+          cache: true
 
       - name: Build documentation
         shell: bash -l {0}
         run: |
-          make html
+          pixi run html
 
       # - name: Check links
       #   shell: bash -l {0}
       #   run: |
-      #     make linkcheck
+      #     pixi run linkcheck
 
       # workaround https://github.com/actions/upload-artifact/issues/38
       - name: tarball

.github/workflows/deploy-docs.yml

@@ -11,17 +11,16 @@ jobs:
         with:
           submodules: true
 
-      - name: Install Conda environment from environment.yml
-        uses: mamba-org/setup-micromamba@v2.0.0
+      - uses: prefix-dev/setup-pixi@v0.8.14
         with:
-          environment-file: environment.yml
-          cache-environment: true
+          pixi-version: v0.51.0
+          cache: true
 
 
       - name: Build documentation
         shell: bash -l {0}
         run: |
-          make html
+          pixi run html
 
       - name: Deploy
         uses: JamesIves/github-pages-deploy-action@3.7.1

.gitignore

@@ -11,3 +11,5 @@ _config_localdev.yml
 _build
 **/.ipynb_checkpoints/*
 __pycache__
+
+.pixi

_InstructionSiteUpdates.md

@@ -56,14 +56,14 @@ It is worth noting that we are using the `source` branch as the base for this re
 
 #### Environment
 
-There is a pre-configured conda environment in `environment.yml`.
-To use it, `conda env create --file environment.yml`, then activate with `conda activate ohw-site`.
+There is a pre-configured conda environment in `pixi.toml`.
+To use it, prefix commands with `pixi run` to make sure the environment is up to date.
 
 #### Commands
 
-- `make live` - The environment is setup with [sphinx-autobuild](https://pypi.org/project/sphinx-autobuild/) which will update open browsers when files are saved. The site will be available at [http://127.0.0.1:8000/](http://127.0.0.1:8000/).
-- `make html` - Launch a one off build of HTML output.
-- `make clean` - Clean all the build directories. This can be useful as Sphinx tries to do incremental builds, and sometimes it will end up out of sync.
+- `pixi run live` - The environment is setup with [sphinx-autobuild](https://pypi.org/project/sphinx-autobuild/) which will update open browsers when files are saved. The site will be available at [http://127.0.0.1:8000/](http://127.0.0.1:8000/).
+- `pixi run html` - Launch a one off build of HTML output.
+- `pixi run clean` - Clean all the build directories. This can be useful as Sphinx tries to do incremental builds, and sometimes it will end up out of sync.
 - `git pull upstream source` to bring in any changes from the main repo.
 
 ### Writing and Linking Pages
@@ -210,7 +210,7 @@ After you create a PR, Netlify will build the site and make a comment with a lin
 While most pages follow the same structure in the repo, as they do on the website, there are a few additional files to be aware of:
 
 - `conf.pd` - This is the Sphinx configuration file.
-- `environment.yml` - The conda environment needed to build the website.
+- `pixi.toml` - The conda environment needed to build the website.
 - `requirements.txt` - A pip installable environment to build the website. This is mainly used by Netlify to create previews of Pull Requests. It is generated with `pip list --format=freeze > requirements.txt`
 - `posts.md` - A stub page that is replaced when blog posts are generated.
 - `_build/` - Automatically generated output from Sphinx.