Merge pull request #23 from Wakoma/smart_doc

Smart documentation for any Nimble configuration

.github/workflows/build.yml

@@ -0,0 +1,56 @@
+# SPDX-FileCopyrightText: 2023 Robin Vobruba <[email protected]>
+# SPDX-FileCopyrightText: 2024 Andreas Kahler <[email protected]>
+#
+# SPDX-License-Identifier: Unlicense
+
+name: Build
+
+on: [push, pull_request]
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+
+    name: Compile
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Check out the repo"
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+
+      - name: Fix checkout ownership
+        run: |
+          # HACK Workaround for bug:
+          # https://github.com/actions/runner/issues/2033
+          mkdir -p /home/runner/work/_temp/_github_home
+          printf "[safe]\n\tdirectory = /github/workspace" \
+            > /home/runner/work/_temp/_github_home/.gitconfig
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install requirements
+        run: |
+          pip install -r requirements.txt
+
+      - name: Generate STL
+        run: |
+          python generate_static.py
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: "build/static/"
+

.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+# SPDX-FileCopyrightText: 2023 Robin Vobruba <[email protected]>
+# SPDX-FileCopyrightText: 2024 Andreas Kahler <[email protected]>
+#
+# SPDX-License-Identifier: Unlicense
+
+name: Publish
+
+on:
+  workflow_run:
+    workflows: Build 
+    branches: master
+    types: completed
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Deployment job
+  deploy:
+    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@v1