Adding documentation building to CI

.github/workflows/documentation.yml

@@ -3,14 +3,33 @@ name: Documentation
 on:
   push:
     branches:
-      - main
+      - add-swift-docc # release/4_0
+      # ^ for now, we only want to use the v4.0 release branch.
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v3
+
+      - name: Build Docs
+        run: |
+          swift package --allow-writing-to-directory ./docs \
+            generate-documentation --include-extended-types \
+                                   --disable-indexing \
+                                   --output-path ./docs \
+                                   --transform-for-static-hosting \
+                                   --hosting-base-path OpenAPIKit \
+                                   --target OpenAPIKit
+
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/[email protected]
+        with:
+          folder: docs
+          branch: gh-pages
+
+
         # TODO: replace the documentation generator with something that is still maintained.
 
 #      - name: Generate Documentation