Skip to content

Commit 1f3c1c6

Browse files
authored
Add DocC plugin and integrate with Swift Package Index (jpsim#354)
Following the instructions here: https://blog.swiftpackageindex.com/posts/auto-generating-auto-hosting-and-auto-updating-docc-documentation Only install Swift DocC plugin on Swift 5.6.x on macOS.
1 parent 325d864 commit 1f3c1c6

File tree

3 files changed

+28
-0
lines changed

3 files changed

+28
-0
lines changed

.spi.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
version: 1
2+
builder:
3+
configs:
4+
- documentation_targets: [Yams]

Package.resolved

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Package.swift

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
// swift-tools-version:5.4
22
import PackageDescription
33

4+
let dependencies: [Package.Dependency]
5+
#if swift(>=5.6) && swift(<5.7) && os(macOS)
6+
dependencies = [.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")]
7+
#else
8+
dependencies = []
9+
#endif
10+
411
let package = Package(
512
name: "Yams",
613
products: [
714
.library(name: "Yams", targets: ["Yams"])
815
],
16+
dependencies: dependencies,
917
targets: [
1018
.target(
1119
name: "CYaml",

0 commit comments

Comments
 (0)