Skip to content

Commit 36f9d1a

Browse files
docs: only use one target for SPI documentation (#374)
Update .spi.yml Remove additional documentation targets which are platform flavours. @cbaker6 Corey, I believe the intention here was to create four different doc sets here, one per platform. Unfortunately, that's not how our DocC generation (or DocC generation in general?) works. The docset for all four targets is called `parseswift` and they end up simply overwriting each other in sequence. So currently you're hosting the last one, for watchOS. It's an outstanding item on my todo list to bring up with the DocC working group how multi-platform docsets are supposed to be generated and hosted side-by-side. I don't think there's anything we can do at the moment to address this :( I'm not sure to what extent you have control over creating entirely separate doc targets which would allow you to ship separate sets per platform if they're materially different. If that's the case, would you like to open a discussion over in https://github.com/SwiftPackageIndex/SwiftPackageIndex-Server/discussions to see if this can be worked around somehow? I can go into more detail how the process works from our end which might allow experimentation on your end. If there is one canonical or best suited set of docs to generate, it's best to only specify that for now!
1 parent 3b3b839 commit 36f9d1a

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

.spi.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ builder:
55
scheme: "ParseSwift (iOS)"
66
- platform: macos-xcodebuild
77
scheme: "ParseSwift (macOS)"
8-
documentation_targets: ["ParseSwift (iOS)", "ParseSwift (macOS)", "ParseSwift (tvOS)", "ParseSwift (watchOS)"]
8+
documentation_targets: ["ParseSwift (macOS)"]
99
- platform: macos-xcodebuild-arm
1010
scheme: "ParseSwift (macOS)"
1111
- platform: tvos

0 commit comments

Comments
 (0)