Documentation (#4)

* Update Swift Version and Badges

* Add Social Image Tests

* Update Image HTML

* Update Social Image

* Update Social Image

* Comprehensive Documentation

* Docc Landing Page

* Create LICENSE

* SPI Shields

* Split Documentation

* .swift-version

* Link APIs to Documentation

* documentation workflow

* Deploy Documentation Adjustments

* Use docbuild

* Documentation Workflow Update

* Swift Package Index Manifest

.github/workflows/documentation.yml

@@ -0,0 +1,52 @@
+name: Deploy Documentation
+
+on:
+  push:
+    tags:
+      - '*'
+  workflow_dispatch:
+
+# Set permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages.
+permissions:
+  contents: read
+  id-token: write
+  pages: write
+
+# Allow one concurrent deployment. Do not cancel in-flight deployments because we don't want assets to be in a
+# a semi-deployed state.
+concurrency: 
+  group: "documentation"
+  cancel-in-progress: false
+
+jobs:
+  deploy-documentation:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: macos-15
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set Up GitHub Pages
+        uses: actions/configure-pages@v3
+      - name: Build Documentation
+        run: |
+          xcodebuild docbuild \
+            -scheme HierarchyResponder \
+            -derivedDataPath ./build \
+            -destination 'generic/platform=iOS';
+          mkdir public;
+          $(xcrun --find docc) process-archive \
+            transform-for-static-hosting ./build/Build/Products/Debug-iphoneos/HierarchyResponder.doccarchive \
+            --hosting-base-path HierarchyResponder \
+            --output-path ./public;
+      - name: Create index.html
+        run: |
+          echo "<script>window.location.href += \"/documentation/hierarchyresponder\"</script>" > ./public/index.html;
+      - name: Upload Documentation Artifact to GitHub Pages
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: public
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.spi.yml

@@ -0,0 +1,3 @@
+version: 1
+external_links:
+  documentation: "https://emiliopelaez.github.io/HierarchyResponder/"

.swift-version

@@ -1 +1 @@
-5.5
+5.10

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Emilio Pelaez Romero
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 5.9
+// swift-tools-version: 5.10
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription