search

twodayslate / swift-package-registry

A Swift Package Registry
https://swiftpkg.dev
ISC License
26 stars 6 forks source link

Swift-DocC generation #63

Open twodayslate opened 2 years ago

twodayslate commented 2 years ago

With the release of Swift 5.6 documentation generation is now easier

https://www.swift.org/blog/swift-5.6-released/

Swift-DocC Updates

Swift-DocC is now available as a SwiftPM plugin using the new plugin command support. See the documentation to learn how to get started.

In addition, you can now use Swift-DocC to publish static content to GitHub Pages.

Other enhancements include:

The docc command-line tool is now a part of the open-source, release Swift toolchain for macOS and Linux platforms. Swift-DocC can now build documentation that is compatible with static hosting environments, like GitHub Pages. Swift-DocC can now produce documentation for executable targets like command-line tools and apps. Be sure to check out Joseph Heck’s great blog post covering this is in more detail.

It would be great if spr could host this documentation automatically. GitHub pages wouldn't even be needed. Got to think about any security concerns tho...