swiftlang / swift-docc-plugin

Swift Package Manager command plugin for Swift-DocC
https://swiftpackageindex.com/swiftlang/swift-docc-plugin/documentation/swiftdoccplugin
Apache License 2.0
323 stars 52 forks source link

Cannot Specify Platform For Documents Generation #38

Open justinguo opened 1 year ago

justinguo commented 1 year ago

Currently we cannot specify the build platform for swift-docc-plugin. This means that the generate-documentation command only generates documentation for macOS. We hope that in the future there can be a -platform flag to allow document generation for a specific platform.

Checklist

Expected behavior

There can be a -platform flag to allow document generation for a specific platform. For example, we can generate documents for iOS platform or tvOS platform.

Actual behavior

The generate-documentation command only generates documentation for macOS.

Steps to Reproduce

Run swift package generate-documentation, it is no possible to specify the platform information.

Swift-DocC Plugin Version Information

Swift-DocC plugin version: https://github.com/apple/swift-docc-plugin/commit/5f2e247f5efef4ff8ee603443a9a29225ce9f0e2 Swift Compiler version: swift-driver version: 1.62.15 Apple Swift version 5.7.1 (swiftlang-5.7.1.135.2 clang-1400.0.29.51) Target: arm64-apple-macosx13.0

x-0o0 commented 1 year ago

Any updates?

JonnyBeeGod commented 1 month ago

It is possible to provide a --destination to swift build only compiling for a specific platform. I am wondering whether it would be possible to add this to swift package generate-documentation as well, simply passing the destination to swift build?