ci: update docs tooling

Author: rmfranken

.github/workflows/docs.yml

@@ -1,25 +1,78 @@
-# name: Build ontology docs
+name: SHACL Documentation Generation
 
-# on:
-#   workflow_call:
+on:
+  push:
+    paths:
+      - 'build/ontology/**'
+  pull_request:
+    paths:
+      - 'build/ontology/**'
 
-# jobs:
+jobs:
+  generate-docs:
+    runs-on: ubuntu-latest
 
-#   build:
-#     runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
-#     steps:
+      - name: Set up Python and install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install rdflib
 
-#       - uses: actions/checkout@v4
+      - name: Enrich ontology with rdflib
+        id: enrich
+        run: |
+          python tools/python/docs/sparql.py
+          echo "enriched_file=/tmp/enriched.ttl" >> $GITHUB_ENV
+          
 
-#       - name: Set up Python
-#         uses: actions/setup-python@v5
-#         with:
-#           python-version: '3.12'
+      - name: Set up Java 11
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '11'
 
-#       - name: Install dependencies
-#         run: |
-#           python -m pip install --upgrade pip
-#           pip install 
+      - name: Install Graphviz
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y graphviz
 
-# TODO: BUILD DOCUMENTATION USING RESPECTER
+      - name: Set DOT_PATH environment variable
+        run: echo "GRAPHVIZ_DOT=/usr/bin/dot" >> $GITHUB_ENV
+
+      - name: Download SHACL Play CLI
+        run: |
+          wget https://github.com/sparna-git/shacl-play/releases/download/0.10.2/shacl-play-app-0.10.2-onejar.jar -O shacl-play-cli.jar
+
+      - name: Generate Documentation
+        run: |
+          java -jar shacl-play-cli.jar \
+            doc \
+            -d \
+            -i ${{ env.enriched_file }} \
+            -l en \
+            -o docs/index.html
+
+      - name: Generate Ontology Diagram
+        run: |
+          java -jar shacl-play-cli.jar \
+            draw \
+            -i ${{ env.enriched_file }} \
+            -o docs/ontology.svg 
+
+      - name: Commit generated docs
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add docs/index.html
+          git add docs/ontology.svg
+          git commit -m "Update generated docs" || echo "Nothing to commit"
+          git push
+
+      - name: Upload generated documentation as an artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: shacl-documentation
+          path: docs/index.html

tools/python/docs/sparql.py

@@ -0,0 +1,60 @@
+from rdflib import Graph, Namespace, URIRef
+import tempfile
+import os
+
+# Define SHACL namespace
+SH = Namespace("http://www.w3.org/ns/shacl#")
+
+# Load the input ontology
+g = Graph()
+g.parse("build/ontology_combined.ttl", format="turtle")
+
+to_replace = []
+for s, p, o in g.triples((None, SH.node, None)):
+    to_replace.append((s, p, o))
+
+for s, p, o in to_replace:
+    g.remove((s, p, o))
+    g.add((s, SH.term("notanode"), o))
+
+insert_query = """
+PREFIX sh: <http://www.w3.org/ns/shacl#>
+INSERT {
+  ?parentShape sh:node ?newNodeShape .
+  ?newNodeShape a sh:NodeShape .
+  ?newNodeShape sh:property ?innerPropertyShape .
+  ?innerPropertyShape ?p ?o .
+}
+WHERE {
+  ?parentShape sh:notanode ?anonShape .
+  ?anonShape sh:property ?innerPropertyShape .
+  ?innerPropertyShape sh:hasValue ?val ;
+                      ?p ?o .
+  FILTER(isIRI(?val))
+  FILTER(isBlank(?anonShape))
+  FILTER(isBlank(?innerPropertyShape))
+  BIND(IRI(CONCAT(STR(?val), "Shape")) AS ?newNodeShape)
+}
+"""
+g.update(insert_query)
+
+delete_query = """
+PREFIX sh: <http://www.w3.org/ns/shacl#>
+DELETE {
+  ?s sh:notanode ?something .
+}
+WHERE {
+  ?s sh:notanode ?something .
+}
+"""
+g.update(delete_query)
+
+
+# Use a predictable path for the enriched ontology
+enriched_file = "/tmp/enriched.ttl"
+ttl_data = g.serialize(format="turtle")
+with open(enriched_file, "w") as f:
+  f.write(ttl_data)
+print("Ontology enriched with new node shapes.")
+print(ttl_data)
+print(f"Enriched ontology saved to: {enriched_file}")