Build & Deploy Actions

Author: navarr

.github/workflows/deploy.yml

@@ -0,0 +1,37 @@
+name: Build & Deploy Documentation
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: main
+      url: ${{ steps.deployment.outputs.page_url }}
+    name: Build Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Run Sphinx documentation build
+        uses: ammaraskar/[email protected]
+        with:
+          docs-folder: "docs/"
+      - name: Upload documentation artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: documentation
+          path: _build/html/
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.github/workflows/pr.yml

@@ -0,0 +1,20 @@
+name: Build & Deploy Documentation
+on:
+  pull_request:
+
+jobs:
+  build:
+    name: Build Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Run Sphinx documentation build
+        uses: ammaraskar/[email protected]
+        with:
+          docs-folder: "docs/"
+      - name: Upload documentation artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: documentation
+          path: _build/html/