#29 GitHub actions to automate documentation site build on new release

.github/workflows/documentation.yaml

@@ -0,0 +1,115 @@
+# .github/workflows/docs.yml
+
+name: Build & Deploy Sphinx Docs
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: write 
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    env:
+      PANDOC_VERSION: ${{ vars.PANDOC_VERSION }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Get tag name
+        id: get_tag
+        run: echo "tag=${GITHUB_REF_NAME}" >> $GITHUB_OUTPUT
+
+      - name: Show tag
+        run: |
+          echo "Tag: ${{ steps.get_tag.outputs.tag }}"
+
+      - name: Extract version without "v"
+        id: version
+        run: |
+          RAW_TAG="${GITHUB_REF_NAME}"     
+          VERSION="${RAW_TAG#v}"
+          VERSION="${VERSION%.*}"
+          echo "clean_version=$VERSION" >> $GITHUB_OUTPUT
+          echo $clean_version
+
+      - name: Update conf.py release version
+        run: |
+          sed -i "s/^release = .*/release = '${{ steps.version.outputs.clean_version }}'/" docs/source/conf.py
+          head -n 20 docs/source/conf.py
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+
+      - name: Install Poetry
+        run: |
+          pip install poetry
+
+      - name: Download and install Pandoc
+        run: |
+          FILE="pandoc-${PANDOC_VERSION}-1-amd64.deb"
+          URL="https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/${FILE}"
+
+          echo "Downloading $FILE..."
+          curl -L -o pandoc.deb "$URL"
+
+          echo "Installing Pandoc..."
+          sudo dpkg -i pandoc.deb
+
+      - name: Verify Pandoc version
+        run: pandoc --version
+
+      - name: Install dependencies
+        run: |
+          poetry lock
+          poetry install --with docs
+          eval $(poetry env activate)
+
+      - name: Checkout gh-pages branch to get versions.json
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+          path: gh-pages           
+
+      - name: Update version.json
+        run: |
+          VERSION=${{ steps.version.outputs.clean_version }}
+          python .github/workflows/update_version_json.py "$VERSION" "gh-pages"
+          cat gh-pages/versions.json
+          mkdir docsVersion
+          cp gh-pages/versions.json docsVersion/versions.json           
+
+      - name: Build Sphinx docs
+        run: |
+          eval $(poetry env activate)
+          make -C docs clean
+          make -C docs html
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docsVersion
+          keep_files: true
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build/html
+          destination_dir: v${{ steps.version.outputs.clean_version }}
+          keep_files: true
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build/html
+          destination_dir: latest
+          keep_files: true

.github/workflows/update_version_json.py

@@ -0,0 +1,44 @@
+import json
+import os
+import sys
+from pathlib import Path
+
+def rebuild_version_json(current_version, gh_pages_path, site_url="https://cvs-health.github.io/uqlm"):
+    version_json_path = Path(gh_pages_path) / "versions.json"
+    entries = []
+
+    # List only v* folders, ignore 'latest'
+    folders = [
+        p for p in Path(gh_pages_path).iterdir()
+        if p.is_dir() and p.name.startswith("v")
+    ]
+
+    folders = sorted(folders, key=lambda f: tuple([ int(x) for x in f.name[1:].split('.')]), reverse=True)
+
+    entries.append({
+            "name": f"v{current_version} (latest)",
+            "version": current_version,
+            "url": f"{site_url}/latest/"
+        })
+    for folder in folders:
+        version = folder.name[1:]  # strip leading 'v'
+        entry = {
+            "name": f"v{version}",
+            "version": version,
+            "url": f"{site_url}/v{version}/"
+        }
+
+        entries.append(entry)
+
+    # Save version.json
+    with open(version_json_path, "w") as f:
+        json.dump(entries, f, indent=4)
+
+if __name__ == "__main__":
+    if len(sys.argv) != 3:
+        print("Usage: python rebuild_version_json.py <current_version> <gh_pages_path>")
+        sys.exit(1)
+
+    current_version = sys.argv[1]
+    gh_pages_path = sys.argv[2]
+    rebuild_version_json(current_version, gh_pages_path)

docs/Makefile

@@ -0,0 +1,36 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+# Get the parent dir name which is this docs' version
+VERSION := $(notdir $(CURDIR))
+
+github:
+	@rm -rf build/html build/doctrees source/_autosummary/*.rst
+	@cp -rf ../../assets/* source/_static/
+	@cp -rf ../../examples/* source/_notebooks/examples/
+	@make html
+	@mkdir -p ../../docs/$(VERSION)
+	@rm -rf ../../docs/$(VERSION)/*
+	@cp -a build/html/. ../../docs/$(VERSION)/
+	@cp ../versions.json ../../docs/versions.json
+
+local:
+	@python -m http.server --directory ../../docs/$(VERSION)/ 8080

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd