Remove Docc Plugin Dependency #617
Conversation
Resolve a regression in the Windows build. We can restore this dependency once we've verified the correct way for all clients of this library to consume it. NOTE: This does not affect existing docc documentation. You can build that at your desk in Xcode with Product > Build Documentation.
|
@swift-ci test |
| @@ -149,12 +149,3 @@ let package = Package( | |||
| ), | |||
| ] | |||
| ) | |||
|
|
|||
| #if swift(>=5.6) | |||
There was a problem hiding this comment.
Should we consider just also adding a conditional check for Windows here? Swift-DocC doesn't ship in the Windows toolchain so the plugin won't be applicable there for some time.
It might be worth leaving it around for non-Xcode users in the meantime though.
There was a problem hiding this comment.
It's still unclear to me why we need a dependency on this plugin to ship docc docs outside of Xcode. To my mind, this is something SourceKit-lsp should take care of.
There was a problem hiding this comment.
It's for building and previewing documentation locally. Longer term, I agree that the plugin should probably be included in the toolchain by default (I'm not sure if sourcekit-lsp is the right place or if we should have a notion of default SwiftPM plugins) so that we have out-of-the-box support for docs. But we would need to have more discussion around that.
There was a problem hiding this comment.
The plugin can be built on Windows even if the rest of DocC cannot be supported due to the dependency on NIO.
Resolve a regression in the Windows build. We can restore this
dependency once we've verified the correct way for all clients
of this library to consume it.
NOTE: This does not affect existing docc documentation. You can build
that at your desk in Xcode with Product > Build Documentation.