Merge pull request #23 from playbook-ui/docc

Generate docs using DocC

Author: ra1028

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+# https://github.com/actions/virtual-environments
+
+name: docs
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+env:
+  DEVELOPER_DIR: /Applications/Xcode_15.2.app
+
+jobs:
+  publish-docs:
+    name: Publish Documentation
+    runs-on: macos-13
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build docs
+        run: make docs
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs

.gitignore

@@ -30,3 +30,6 @@ node_modules
 
 ## Visual regression test
 Snapshots
+
+## Documentation
+docs

Makefile

@@ -18,6 +18,13 @@ lint:
 npm:
 	npm i
 
+.PHONY: docs
+docs:
+	xcodebuild docbuild \
+	  -scheme PlaybookAccessibilitySnapshot \
+	  -destination generic/platform=iOS \
+	  OTHER_DOCC_FLAGS="--transform-for-static-hosting --hosting-base-path accessibility-snapshot-ios --output-path docs"
+
 .PHONY: fix-readme-links
 fix-readme-links:
 	sed -i '' -E '/.?http/!s#(<img src=")([^"]+)#\1$(GITHUB_RAW_CONTENT_PATH)\2#g' README.md

README.md

@@ -17,7 +17,7 @@
 
 ## Usage
 
-- [API Document](https://playbook-ui.github.io/accessibility-snapshot-ios)
+- [API Document](https://playbook-ui.github.io/accessibility-snapshot-ios/documentation/playbookaccessibilitysnapshot)
 - [Example App](https://github.com/playbook-ui/accessibility-snapshot-ios/tree/main/Example)
 
 ---