swift-nio icon indicating copy to clipboard operation
swift-nio copied to clipboard

Enable Documentation building on the Swift Package Index

Open weissi opened this issue 3 years ago • 1 comments

Swift Package Index just launched the awesome feature which generates docs for any package. SwiftNIO should enable this by adding the required .spm.yml etc.

weissi avatar Jun 03 '22 16:06 weissi

Am I right in thinking that this only requires adding a file to the root of the repo (.spi.yml) that contains the following: ?

version: 1
builder:
  configs:
    - documentation_targets: [
		NIOCore,
		NIOEmbedded,
		NIOPosix,
		NIOHTTP1,
		NIOFoundationCompat,
		NIOWebSocket,
		NIOConcurrencyHelpers,
		NIOTLS,
		NIOTestUtils
	]

Diggory avatar Jun 22 '22 07:06 Diggory

This was done in https://github.com/apple/swift-nio/pull/2324

glbrntt avatar Jan 23 '23 13:01 glbrntt