From 6b8deec13ba3815d49c2d5ad94afc5b13d2167e2 Mon Sep 17 00:00:00 2001
From: bbm <brian.maranville@nist.gov>
Date: Wed, 16 Oct 2024 13:57:29 -0400
Subject: [PATCH] workflow to build (with pdoc3) and deploy docs to GitHub
 Pages

---
 .github/workflows/build-docs.yml | 59 ++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 .github/workflows/build-docs.yml

diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
new file mode 100644
index 0000000..1d462de
--- /dev/null
+++ b/.github/workflows/build-docs.yml
@@ -0,0 +1,59 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Build and deploy docs to GitHub Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # 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:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.config.py }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install . build
+          python -m build
+
+      - name: Build the docs
+        run: |
+          pip install pdoc3
+          pdoc --html molgroups
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: './html/molgroups'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4