Move to docc documentation

david-swift · Apr 13, 2024 · 1912b32 · 1912b32
1 parent 23fd02d
commit 1912b32
Show file tree

Hide file tree

Showing 32 changed files with 130 additions and 907 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,44 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: ["main"]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  Deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: macos-14
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build Docs
+        run: |
+          xcrun xcodebuild docbuild \
+            -scheme SettingsKit \
+            -destination 'generic/platform=macOS' \
+            -derivedDataPath "$PWD/.derivedData"
+          xcrun docc process-archive transform-for-static-hosting \
+            "$PWD/.derivedData/Build/Products/Debug/Adwaita.doccarchive" \
+            --output-path "docs" \
+            --hosting-base-path "settingskit-macos"
+      - name: Modify Docs
+        run: |
+          echo "<script>window.location.href += \"/documentation/settingskit\"</script>" > docs/index.html;
+          sed -i '' 's/,2px/,10px/g' docs/css/index.038e887c.css
+      - name: Upload Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/.gitignore b/.gitignore
@@ -7,4 +7,5 @@ DerivedData/
 .swiftpm/
 .netrc
 /Package.resolved
-.Ulysses-Group.plist
+.Ulysses-Group.plist
+/.docc-build
diff --git a/Documentation/Reference/SettingsKit/README.md b/Documentation/Reference/SettingsKit/README.md
diff --git a/Documentation/Reference/SettingsKit/classes/SettingsModel.md b/Documentation/Reference/SettingsKit/classes/SettingsModel.md
diff --git a/Documentation/Reference/SettingsKit/enums/SettingsAction.md b/Documentation/Reference/SettingsKit/enums/SettingsAction.md
diff --git a/Documentation/Reference/SettingsKit/enums/TabType.md b/Documentation/Reference/SettingsKit/enums/TabType.md
diff --git a/Documentation/Reference/SettingsKit/extensions/ButtonStyle.md b/Documentation/Reference/SettingsKit/extensions/ButtonStyle.md
diff --git a/Documentation/Reference/SettingsKit/extensions/CGFloat.md b/Documentation/Reference/SettingsKit/extensions/CGFloat.md
diff --git a/Documentation/Reference/SettingsKit/extensions/Double.md b/Documentation/Reference/SettingsKit/extensions/Double.md
diff --git a/Documentation/Reference/SettingsKit/extensions/KeyboardShortcut.md b/Documentation/Reference/SettingsKit/extensions/KeyboardShortcut.md