Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@ name: Swift
on: [push]

jobs:
documentation:
runs-on: macos-latest
steps:
- uses: actions/checkout@v3
- name: Generate documentation
run: xcodebuild docbuild -scheme AnimationPlanner -derivedDataPath DerivedData -destination 'platform=iOS Simulator,name=iPhone 13'
- name: Process documentation
run: $(xcrun --find docc) process-archive transform-for-static-hosting DerivedData/Build/Products/Debug-iphonesimulator/AnimationPlanner.doccarchive --output-path ./docs --hosting-base-path AnimationPlanner

build:
runs-on: macos-latest
steps:
Expand Down
7 changes: 7 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
- uses: fwcd/swift-docc-action@v1
with:
target: AnimationPlanner
output: ./docs
hosting-base-path: AnimationPlanner
disable-indexing: 'true'
transform-for-static-hosting: 'true'
16 changes: 16 additions & 0 deletions Package.resolved

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,9 @@ let package = Package(
dependencies: ["AnimationPlanner"]),
]
)
#if swift(>=5.6)
// Add the documentation compiler plugin if possible
package.dependencies.append(
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")
)
#endif