Build docs using github actions

finnvoor · Mar 26, 2024 · 39e7fa2 · 39e7fa2
1 parent 163aa98
commit 39e7fa2
Show file tree

Hide file tree

Showing 672 changed files with 49 additions and 1,036 deletions.
diff --git a/.github/workflows/BuildDocs.yml b/.github/workflows/BuildDocs.yml
@@ -0,0 +1,47 @@
+name: Deploy Documentation
+on:
+  push:
+    branches: ["main", "improvement/github-actions-docc"]
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+jobs:
+  DeployDocs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: macos-14
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Swift
+        uses: SwiftyLab/setup-swift@latest
+        with:
+          development: true
+          swift-version: latest
+          check-latest: true
+      - name: Select Xcode
+        run: sudo xcode-select -s '/Applications/Xcode_15.2.app'
+      - name: Install Playdate SDK
+        uses: pd-rs/[email protected]
+      - name: Build
+        run: |
+          xcodebuild docbuild -scheme PlaydateKit \
+            -configuration Release \
+            -derivedDataPath /tmp/docc \
+            -destination 'platform=macOS' \
+            -toolchain "swift latest";
+          $(xcrun -f docc -toolchain "swift latest") process-archive \
+            transform-for-static-hosting $(find /tmp/docc -type d -name '*.doccarchive') \
+            --hosting-base-path PlaydateKit \
+            --output-path docs;
+      - name: Upload
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: 'docs'
+      - name: Deploy
+        id: deployment
+        uses: actions/deploy-pages@v1
diff --git a/Package.swift b/Package.swift
@@ -1,4 +1,4 @@
-// swift-tools-version: 5.10
+// swift-tools-version: 5.9
 
 import PackageDescription
 

diff --git a/Sources/PlaydateKit/Documentation.docc/Documentation.md b/Sources/PlaydateKit/Documentation.docc/Documentation.md
@@ -4,7 +4,7 @@
     @PageImage(purpose: icon, source: "Logo")
 }
 
-Create games for Playdate using Swift.
+Create artisinal games for Playdate using Swift.
 
 ## Topics
 

diff --git a/docs/css/223.5ab1188f.css b/docs/css/223.5ab1188f.css
diff --git a/docs/css/427.ee43802d.css b/docs/css/427.ee43802d.css
diff --git a/docs/css/documentation-topic.5ce24f8e.css b/docs/css/documentation-topic.5ce24f8e.css
diff --git a/docs/css/index.33ec2115.css b/docs/css/index.33ec2115.css
diff --git a/docs/css/topic.7ff1c1f8.css b/docs/css/topic.7ff1c1f8.css
diff --git a/docs/css/tutorials-overview.e4891d45.css b/docs/css/tutorials-overview.e4891d45.css
diff --git a/docs/data/documentation/playdatekit.json b/docs/data/documentation/playdatekit.json