Merge pull request #1 from ISC-HEI/dev

Dev

Author: sdevenes

.github/workflows/scaladoc.yml

@@ -0,0 +1,30 @@
+name: Generate and Deploy ScalaDoc
+
+on:
+  create:
+    tags:
+      - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+
+      - name: Build and Generate ScalaDoc
+        run: |
+          ./gradlew scaladoc
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: build/docs/scaladoc

README.md

@@ -1,6 +1,7 @@
 # FunGraphics
 
 A library used for teaching computer science in the [ISC](https://www.hevs.ch/isc) degree programme, notably for the course 101.1.
+The documentation is available [here](https://isc-hei.github.io/FunGraphics/). It is automatically built and published each time a new version tag is added to the repo.
 
 ## Origin