Add instructions to build R packages (#1886)

* Update deprecated field

* Add pixi.lock to ignore list

* Add README to docs

* Add instructions for building R pkgs

* Update actions

* Update pixi version

* Update setup-pixi action

* Try excluding docs dir

* Revert last commit

Author: IsabelParedes

.github/workflows/build_docs.yaml

@@ -32,17 +32,17 @@ jobs:
       ################################################################
       # CONFIG
       ################################################################
-      - uses: prefix-dev/setup-pixi@v0.6.0
+      - uses: prefix-dev/setup-pixi@v0.8.2
         with:
-          pixi-version: v0.20.1
+          pixi-version: v0.41.1
       - run: |
           pixi run docs-build -d docs_build
 
       ################################################################
       # upload to github pages
       ################################################################
       - name: Upload Pages artifact
-        uses: actions/upload-pages-artifact@v2
+        uses: actions/upload-pages-artifact@v3
         with:
           path: docs_build
 
@@ -69,4 +69,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v3 # or specific "vX.X.X" version tag for this action
+        uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action

.gitignore

@@ -9,6 +9,7 @@ Untitled.ipynb
 
 # pixi folder
 .pixi/
+pixi.lock
 # rattler-build output folder
 output/
 

docs/README.md

@@ -0,0 +1,23 @@
+# Emscripten-Forge Documentation
+
+Follow the instructions below to build the documentation locally.
+
+1. Install `pixi` in your environment.
+
+    ```bash
+    micromamba install pixi -c conda-forge
+    ```
+
+2. Build the documentation.
+
+    ```bash
+    pixi run docs-build -d _build
+
+    ```
+
+3. The generated documentation can be found in the `_build` directory. Use your favorite server.
+
+    ```bash
+    cd _build
+    python -m http.server
+    ```

docs/development/adding_packages.md

@@ -94,7 +94,7 @@ endian = 'little'
 
 [binaries]
 exe_wrapper = 'node'
-pkgconfig = 'pkg-config'
+pkg-config = 'pkg-config'
 
 ```
 
@@ -144,3 +144,35 @@ requirements:
 * [cryptography](https://github.com/emscripten-forge/recipes/tree/main/recipes/recipes_emscripten/cryptography)
 * [pydantic-core](https://github.com/emscripten-forge/recipes/tree/main/recipes/recipes_emscripten/pydantic-core)
 * [pycrdt](https://github.com/emscripten-forge/recipes/tree/main/recipes/recipes_emscripten/pycrdt)
+
+
+## R Packages
+
+A typical R package requires at least one compiler and the `cross-r-base` package.
+
+```yaml
+requirements:
+  build:
+  - ${{ compiler('cxx') }}
+  - cross-r-base
+  host:
+  - r-base
+  run:
+  - r-base
+```
+
+To build the package, a one-line script is sufficient:
+
+```bash
+$R CMD INSTALL $R_ARGS --no-byte-compile .
+```
+
+If the package requires a Fortran compiler, then `flang` must be installed in the build script.
+
+Please note that the `cross-r-base` package adds files to the `$PREFIX` directory which do not belong to the package being built. This is because the build for `r-base` on conda-forge is different than the build for `r-base` on emscripten-forge. To avoid packaging irrelevant files, we filter files with an [outputs section](https://rattler.build/latest/reference/recipe_file/#outputs-section).
+
+**Example recipes**:
+
+- [r-bit](https://github.com/emscripten-forge/recipes/blob/main/recipes/recipes_emscripten/r-bit/recipe.yaml)
+- [r-colorspace](https://github.com/emscripten-forge/recipes/blob/main/recipes/recipes_emscripten/r-colorspace/recipe.yaml)
+- [r-nlme](https://github.com/emscripten-forge/recipes/blob/main/recipes/recipes_emscripten/r-nlme/recipe.yaml) (uses `flang`)

pixi.toml

@@ -64,7 +64,7 @@ cmd = [
 
 
 [feature.feature_rattler_build.tasks.setup]
-depends_on = ["build-emscripten-compiler-pkg", "build-cross-python-pkg", "build-pytester-pkg"]
+depends-on = ["build-emscripten-compiler-pkg", "build-cross-python-pkg", "build-pytester-pkg"]
 
 
 [feature.feature_rattler_build.tasks.build-emscripten-wasm32-pkg]