Merge pull request #7 from bsipocz/ENH_switch_to_JB2

ENH: switching to JB2 with the docs

Author: bsipocz

.circleci/config.yml

@@ -1,29 +1,66 @@
 version: 2.1
 
-jobs:
 
+jobs:
   build-docs:
     docker:
-      - image: cimg/python:3.11
-
+      - image: cimg/python:3.13
     steps:
       - checkout
 
+      - restore_cache:
+          keys:
+            - node-cache-v1
+
+      - restore_cache:
+          keys:
+            - pip-cache-{{ checksum "site_requirements.txt" }}
+
+      - run:
+          name: Install Node.js
+          command: |
+            curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash -
+            sudo apt-get install -y nodejs
+
       - run:
-          name: Install CI dependencies
-          command: python -m pip install --upgrade tox
+          name: Install mystmd
+          command: |
+            npm install mystmd
+
+      - run:
+          name: Install Python dependencies
+          command: |
+            python -m pip install --upgrade pip
+            if [ -f site_requirements.txt ]; then pip install -r site_requirements.txt; fi
+
+      - save_cache:
+          key: node-cache-v1
+          paths:
+            - node_modules
+
+      - save_cache:
+          key: pip-cache-{{ checksum "site_requirements.txt" }}
+          paths:
+            - ~/.cache/pip
 
       - run:
-          name: Build HTML rendering of notebooks
-          no_output_timeout: 30m
+          name: Build documentation
+          environment:
+            # Ensure this is same as store_artifacts path below
+            DOCS_PATH: _build/html
           command: |
-            python -m tox -e buildhtml
+            export BASE_URL="/output/job/$CIRCLE_WORKFLOW_JOB_ID/artifacts/0/$DOCS_PATH"
+
+            (npx myst build --html)
+
+            ## Temporary hack to remove unused thebe JS
+            rm _build/html/*thebe*.js
 
       - store_artifacts:
           path: _build/html
 
 workflows:
   version: 2
-  default:
+  build-and-docs:
     jobs:
       - build-docs

.github/workflows/ci_publish.yml

@@ -0,0 +1,55 @@
+name: Deploy docs on GitHub Pages
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+env:
+  # `BASE_URL` determines, relative to the root of the domain, the URL that your site is served from.
+  # E.g., if your site lives at `https://mydomain.org/myproject`, set `BASE_URL=/myproject`.
+  # If, instead, your site lives at the root of the domain, at `https://mydomain.org`, set `BASE_URL=''`.
+  BASE_URL: /${{ github.event.repository.name }}
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  deploy_docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+
+      - name: Install Jupyter Book (via myst)
+        run: npm install -g jupyter-book
+
+      - name: Build HTML Assets
+        run: jupyter-book 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/deploy_pages.yml

@@ -0,0 +1,2 @@
+# MyST build outputs
+_build

.gitignore

@@ -19,18 +19,6 @@ The community will also mine SPHEREx data and combine it with synergistic data s
 More information is available in the "Mission Overview" section of the SPHEREx Explanatory Supplement.
 
 
-## SPHEREx Data at IRSA
-
-```{toctree}
----
-maxdepth: 1
----
-
-spherex_data_products
-spherex_data_access
-```
-
-
 ## Additional Resources
 
 [SPHEREx archive at IRSA](https://irsa.ipac.caltech.edu/Missions/spherex.html)

documentation/index.md

@@ -0,0 +1,23 @@
+# See docs at: https://mystmd.org/guide/frontmatter
+version: 1
+project:
+  id: 236e8a7d-de48-4c6b-a0c5-c4bfe3012ea0
+  # title:
+  # description:
+  # keywords: []
+  # authors: []
+  # github:
+  toc:
+    # Auto-generated by `myst init --write-toc`
+    - file: documentation/index.md
+    - title: SPHEREx Data Access
+
+      file: documentation/spherex_data_access.md
+    - title: SPHEREx Data Products at IRSA
+      file: documentation/spherex_data_products.md
+
+site:
+  template: book-theme
+  options:
+    favicon: _static/irsa-favicon.ico
+    logo: _static/irsa_logo.png

myst.yml

@@ -1,4 +0,0 @@
-sphinx
-myst-nb
-sphinx-book-theme
-sphinx-copybutton