Merge pull request #2021 from p-zach/set-up-myst

Set up MyST site deploy

Author: dellaert

.github/workflows/build-linux.yml

@@ -1,6 +1,11 @@
 name: Linux CI
 
-on: [pull_request]
+on:
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - '**.ipynb' 
+      - 'myst.yml'
 
 # Every time you make a push to your PR, it cancel immediately the previous checks,
 # and start a new one. The other runner will be available more quickly to your PR.

.github/workflows/build-macos.yml

@@ -1,7 +1,11 @@
 name: macOS CI
 
-on: [pull_request]
-
+on:
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - '**.ipynb' 
+      - 'myst.yml'
 # Every time you make a push to your PR, it cancel immediately the previous checks, 
 # and start a new one. The other runner will be available more quickly to your PR. 
 concurrency:

.github/workflows/build-python.yml

@@ -1,6 +1,11 @@
 name: Python CI
 
-on: [pull_request]
+on:
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - '**.ipynb' 
+      - 'myst.yml'
 
 # Every time you make a push to your PR, it cancel immediately the previous checks,
 # and start a new one. The other runner will be available more quickly to your PR.

.github/workflows/build-special.yml

@@ -1,6 +1,11 @@
 name: Special Cases CI
 
-on: [pull_request]
+on:
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - '**.ipynb' 
+      - 'myst.yml'
 
 # Every time you make a push to your PR, it cancel immediately the previous checks,
 # and start a new one. The other runner will be available more quickly to your PR.

.github/workflows/build-windows.yml

@@ -1,6 +1,11 @@
 name: Windows CI
 
-on: [pull_request]
+on:
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - '**.ipynb' 
+      - 'myst.yml'
 
 # Every time you make a push to your PR, it cancel immediately the previous checks, 
 # and start a new one. The other runner will be available more quickly to your PR. 

.github/workflows/deploy.yml

@@ -0,0 +1,51 @@
+# This file was initialized with `myst init --gh-pages`
+
+name: MyST GitHub Pages Deploy
+on:
+  push:
+    # Runs on pushes targeting the develop branch
+    branches: [develop]
+    # Only trigger redeploy if Markdown files, notebooks, or config changes
+    paths:
+      - '**.md'
+      - '**.ipynb' 
+      - 'myst.yml'
+env:
+  # `BASE_URL` determines the website is served from, including CSS & JS assets
+  # You may need to change this to `BASE_URL: ''`
+  BASE_URL: /${{ github.event.repository.name }}
+
+# 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:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Install MyST Markdown
+        run: npm install -g mystmd
+      - name: Build HTML Assets
+        run: myst build --html
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './_build/html'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/trigger-packaging.yml

@@ -4,6 +4,10 @@ on:
   push:
     branches:
       - develop
+    paths-ignore:
+      - '**.md'
+      - '**.ipynb' 
+      - 'myst.yml'
 jobs:
   trigger-package-build:
     runs-on: ubuntu-latest

.github/workflows/trigger-python.yml

@@ -4,6 +4,10 @@ on:
   push:
     branches:
       - develop
+    paths-ignore:
+      - '**.md'
+      - '**.ipynb' 
+      - 'myst.yml'
 jobs:
   triggerPython:
     runs-on: ubuntu-latest

.gitignore

@@ -20,3 +20,6 @@ xcode/
 /Dockerfile
 /python/gtsam/notebooks/.ipynb_checkpoints/ellipses-checkpoint.ipynb
 .cache/
+
+# MyST build outputs
+_build

INSTALL.md

@@ -1,4 +1,6 @@
-# Quickstart
+# Installation Guide
+
+## Quickstart
 
 In the root library folder execute: