Repository navigation
Build the Swift Package Index documentation for iOS - #9
Merged
Merged
Conversation
Swift Package Index builds documentation on macOS unless .spi.yml names a platform. MuscleMap's UIKit integration (MuscleMapView, HeatmapLegendUIView) is only compiled where UIKit exists, so a macOS documentation build leaves the UIKit Integration article with ten unresolved symbol links. Building for iOS documents the whole API. Checked with xcodebuild docbuild -destination generic/platform=iOS and --warnings-as-errors: the build succeeds with no warnings, while the macOS build used by default fails with the same flag.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Swift Package Index builds DocC on macOS by default, where the UIKit integration (
MuscleMapView,HeatmapLegendUIView) does not exist, so the UIKit Integration article ends up with ten unresolved links.platform: iosin.spi.ymldocuments the whole API. Verified locally withxcodebuild docbuild -destination generic/platform=iOSand--warnings-as-errors: no warnings.