Updating documentation and documentation system to hyde 2.0

.github/matrix.json

@@ -1,29 +1,29 @@
 {
     "config": [
         {
-            "name": "Linux GCC 11",
+            "name": "Linux GCC 13",
             "compiler": "gcc",
-            "version": "11",
+            "version": "13",
             "os": "ubuntu-22.04"
         },
         {
-            "name": "Linux Clang 14",
+            "name": "Linux Clang 15",
             "compiler": "clang",
-            "version": "14",
+            "version": "15",
             "os": "ubuntu-22.04"
         },
         {
-            "name": "macOS apple-clang 13.0.0",
+            "name": "macOS apple-clang 15.1.0",
             "compiler": "apple-clang",
-            "version": "13.0.0",
-            "os": "macos-11"
+            "version": "15.1.0",
+            "os": "macos-13"
         },
         {
-            "name": "Windows VS2019",
+            "name": "Windows VS2022",
             "compiler": "Visual Studio",
-            "version": "16",
-            "os": "windows-2019",
-            "cmake_toolset": "Visual Studio 16 2019"
+            "version": "17",
+            "os": "windows-2022",
+            "cmake_toolset": "Visual Studio 17 2022"
         },
         {
             "name": "Linux Webassembly",

.github/workflows/jekyll.yml

@@ -0,0 +1,67 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: [$default-branch]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0
+        with:
+          # ruby-version: '3.1' # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          cache-version: 0 # Increment this number if you need to re-download cached gems
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+      - name: Build with Jekyll
+        # Outputs to the './_site' directory by default
+        # run: cd ./docs
+        run: cd ./docs && bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/_site
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/stlab.yml

@@ -21,6 +21,7 @@ jobs:
         run: echo "::set-output name=matrix::$(cat .github/matrix.json | scripts/flatten_json.py)"
 
   builds:
+    # installed tools and runners can be found here: https://github.com/actions/runner-images
     needs: generate-matrix
     runs-on: ${{ matrix.config.os }}
     strategy:
@@ -106,7 +107,7 @@ jobs:
         shell: bash
         run: |
           mkdir ../build
-          cmake -S. -B../build -GNinja -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=23
+          cmake -S. -B../build -GNinja -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=20
 
       - name: Configure // Linux Emscripten
         if: ${{ startsWith(matrix.config.compiler, 'emscripten') }}
@@ -120,7 +121,7 @@ jobs:
         if: ${{ startsWith(matrix.config.os, 'windows') }}
         shell: cmd
         run: |
-          call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" x64
+          call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" x64
           mkdir ..\build
           cmake -S. -B../build -GNinja -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=20 -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake
 
@@ -134,7 +135,7 @@ jobs:
         if: ${{ startsWith(matrix.config.os, 'windows') }}
         shell: cmd
         run: |
-          call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" x64
+          call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" x64
           cmake --build ../build/
 
       - name: Test

README.md

@@ -113,9 +113,7 @@ STLab uses [hyde](https://github.com/adobe/hyde) to generate documentation boile
 When adding a new public API, you should invoke
 
 ```
-docker run --platform linux/x86_64 --mount type=bind,source="$(pwd)/..",target=/mnt/host \
-    --tty --interactive \
-    hyde bash
+docker run --platform linux/x86_64 --mount type=bind,source="$(pwd)/..",target=/mnt/host --tty --interactive hyde bash
 ```
 
 ```

docs/.ruby-version

@@ -1 +1 @@
-2.7.4
+3.2.2

docs/Gemfile

@@ -1,2 +1,8 @@
 source 'https://rubygems.org'
-gem 'github-pages', group: :jekyll_plugins
+gem 'jekyll'
+gem 'jekyll-redirect-from', group: [:jekyll_plugins]
+gem 'jekyll-compose', group: [:jekyll_plugins]
+gem "jekyll-remote-theme", group: [:jekyll_plugins]
+# don't submit this line to the upstream repo
+## Enable this line for local theme development
+# gem 'jekyll-theme-adobe-hyde', path: '../../themes'