Skip to content

Commit ea1aeb6

Browse files
author
Andrea Scuderi
committed
Add DocC plugin
1 parent 292e8f1 commit ea1aeb6

File tree

3 files changed

+35
-1
lines changed

3 files changed

+35
-1
lines changed

Makefile

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,21 @@ local_invoke_demo_app:
3434
test:
3535
swift test --sanitize=thread --enable-code-coverage
3636

37+
generate_docc:
38+
mkdir -p docs && \
39+
swift package --allow-writing-to-directory docs/BreezeLambdaAPI generate-documentation \
40+
--target BreezeLambdaAPI \
41+
--disable-indexing \
42+
--transform-for-static-hosting \
43+
--hosting-base-path "https://swift-serverless.github.io/BreezeLambdaDynamoDBAPI/" \
44+
--output-path docs/BreezeLambdaAPI && \
45+
swift package --allow-writing-to-directory docs/BreezeDynamoDBService generate-documentation \
46+
--target BreezeDynamoDBService \
47+
--disable-indexing \
48+
--transform-for-static-hosting \
49+
--hosting-base-path "https://swift-serverless.github.io/BreezeLambdaDynamoDBAPI/" \
50+
--output-path docs/BreezeDynamoDBService
51+
3752
coverage:
3853
llvm-cov export $(TEST_PACKAGE) \
3954
--instr-profile=$(SWIFT_BIN_PATH)/codecov/default.profdata \

Package.resolved

Lines changed: 19 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Package.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ let package = Package(
3131
.package(url: "https://github.com/swift-server/swift-service-lifecycle.git", from: "2.0.0"),
3232
.package(url: "https://github.com/soto-project/soto.git", from: "7.0.0"),
3333
.package(url: "https://github.com/apple/swift-log.git", from: "1.6.2"),
34+
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
3435
],
3536
targets: [
3637
.executableTarget(

0 commit comments

Comments
 (0)