From 92c4f2ee600c0d74f23f6f15d065ceaa544e433b Mon Sep 17 00:00:00 2001
From: Toon Verstraelen <Toon.Verstraelen@UGent.be>
Date: Fri, 7 Jun 2024 03:59:14 +0200
Subject: [PATCH] GitHub action for docs

---
 .github/workflows/sphinx.yaml | 52 +++++++++++++++++++++++++++++++++++
 doc/gen_inputs.py             |  2 --
 2 files changed, 52 insertions(+), 2 deletions(-)
 create mode 100644 .github/workflows/sphinx.yaml

diff --git a/.github/workflows/sphinx.yaml b/.github/workflows/sphinx.yaml
new file mode 100644
index 00000000..bdca4684
--- /dev/null
+++ b/.github/workflows/sphinx.yaml
@@ -0,0 +1,52 @@
+# Base on examples in https://github.com/actions/starter-workflows/blob/main/pages/
+name: sphinx
+on: push
+
+# 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:
+  # Create the sphinx site
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Install development version
+        run: pip install -e .[dev]
+      - name: Prepare static data for docs
+        run: cd docs; ./gen_docs.sh
+      - name: Run sphix
+        run: python -m sphinx -M . _build IOData
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./doc/_build/html/
+
+  # Deploy site
+  deploy:
+    # Only deploy if we're on the main branch.
+    if: github.ref == 'refs/heads/main'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/doc/gen_inputs.py b/doc/gen_inputs.py
index df9566bb..d62ca931 100755
--- a/doc/gen_inputs.py
+++ b/doc/gen_inputs.py
@@ -67,8 +67,6 @@ def main():
         print("- Requires", _format_words(fn.required))
         if fn.optional:
             print("- May use", _format_words(fn.optional))
-        if fn.kwdocs:
-            print("- Keyword arguments", _format_words(fn.kwdocs))
         if fn.notes:
             print()
             print(fn.notes)