mattie
October 2, 2022, 9:43am
#1
I'm trying to figure out if it's possible for me to include a documentation catalog for a binary target (xcframework). I tried a few things, like a making a Source directory with the same name, but had no luck.
Is such a thing possible?
1 Like
Unfortunately, this is currently not a supported. It might worth opening an issue on the plugin GitHub - apple/swift-docc-plugin: Swift Package Manager command plugin for Swift-DocC
1 Like
mattie
October 3, 2022, 10:18am
#3
Thank you for the confirmation. Issue filed!
opened 10:17AM - 03 Oct 22 UTC
enhancement
### Feature Request: Support for binary targets
#### Description:
I make a… n xcframework, distributed as a SPM binary target. As far as I can tell, there is no way for me to incorporate DocC support for it directly in the package. I think it would be really nice to be able to incorporate documentation.
#### Motivation:
It is totally possible to get this to work out-of-band. But, especially with things like the Swift Package Index building and hosting documentation, finding a way to officially support it would be much more convenient. And, could also help encourage better documentation for binaries distributed this way.
#### Importance:
While my particular package is also open source, I think may binaries distributed this way are not. Encouraging better documentation for these cases would be really welcome.
#### Alternatives Considered
It is possible to get this to work with a custom solution, outside of SPM. But, its a pain, and doesn't work with existing tooling, particularly SPI.
1 Like