Set up docs action

Author: chpolste

.github/workflows/docs.yml

@@ -0,0 +1,34 @@
+name: docs
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: make init
+      - run: make test
+      - run: make docs
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/html/
+
+  deploy:
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -2,10 +2,7 @@
 
 deps
 dist
-docs/*.html
-docs/*.css
-docs/dist
-docs/plot
+docs/html
 node_modules
 test/flottplot.js
 test/*.json

Makefile

@@ -71,45 +71,45 @@ test/flottplot.js: src/bundles/flottplot-test.ts | deps/
 
 # Documentation
 
-DOCS := \
-	docs/ \
-	docs/index.html \
-	docs/tutorial.html \
-	docs/elements.html \
-	docs/values.html \
-	docs/python.html \
-	docs/docs.css \
-	docs/convert.js \
-	docs/dist/flottplot-min.js \
-	docs/dist/flottplot.css \
-	docs/dist/flottplot-scan-min.js \
-	docs/plot/sin-1x.png \
-	docs/plot/sin-2x.png \
-	docs/plot/sin-3x.png \
-	docs/plot/cos-3x.png \
-	docs/plot/cos-2x.png \
-	docs/plot/cos-3x.png \
-	docs/plot/adv_fwd_000.png \
-	docs/plot/adv_bwd_000.png \
-	docs/plot/adv_lag_000.png
-
-docs: $(DOCS)
-
-docs/%.css: docs/src/%.less
+DOCS_HTML := \
+	docs/html/ \
+	docs/html/index.html \
+	docs/html/tutorial.html \
+	docs/html/elements.html \
+	docs/html/values.html \
+	docs/html/python.html \
+	docs/html/docs.css \
+	docs/html/convert.js \
+	docs/html/dist/flottplot-min.js \
+	docs/html/dist/flottplot.css \
+	docs/html/dist/flottplot-scan-min.js \
+	docs/html/plot/sin-1x.png \
+	docs/html/plot/sin-2x.png \
+	docs/html/plot/sin-3x.png \
+	docs/html/plot/cos-3x.png \
+	docs/html/plot/cos-2x.png \
+	docs/html/plot/cos-3x.png \
+	docs/html/plot/adv_fwd_000.png \
+	docs/html/plot/adv_bwd_000.png \
+	docs/html/plot/adv_lag_000.png
+
+docs: $(DOCS_HTML)
+
+docs/html/%.css: docs/src/%.less
 	npx lessc $< $@
 
-docs/%.html: docs/util/build.py docs/src/template.html docs/src/%.html
+docs/html/%.html: docs/util/build.py docs/src/template.html docs/src/%.html
 	python3 $+ > $@
 
-docs/dist/%: dist/% | docs/dist/
+docs/html/dist/%: dist/% | docs/html/dist/
 	cp $^ $@
 
-docs/plot/sin-%x.png: docs/util/plot-trigonometric.py | docs/plot/
+docs/html/plot/sin-%x.png: docs/util/plot-trigonometric.py | docs/html/plot/
 	python3 $< "sin" $* $@
 
-docs/plot/cos-%x.png: docs/util/plot-trigonometric.py | docs/plot/
+docs/html/plot/cos-%x.png: docs/util/plot-trigonometric.py | docs/html/plot/
 	python3 $< "cos" $* $@
 
-docs/plot/adv_%_000.png: docs/util/plot-advection.py | docs/plot/
+docs/html/plot/adv_%_000.png: docs/util/plot-advection.py | docs/html/plot/
 	python3 $< $* $(dir $@)