swift: generate API docs as a DocC archive #2335
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
And include in GitHub release artifacts Updates rules_swift to pull in bazelbuild/rules_swift#838 When users open the archive, they'll have rich docs they can explore using Xcode's documentation navigator. When we update to Xcode 13.4, we'll be able to generate HTML docs with this approach and publish to the documentation website. Signed-off-by: JP Simard <jp@jpsim.com>
I completely agree, and this will be possible when we update to Xcode 13.4, tracked in #2100. |
For more context, this is the Xcode 13.4 feature we need for static website hosting: apple/swift-docc#44 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
And include in GitHub release artifacts
Updates rules_swift to pull in bazelbuild/rules_swift#838
When users open the archive, they'll have rich docs they can explore using Xcode's documentation navigator.
When we update to Xcode 13.4, we'll be able to generate HTML docs with this approach and publish to the documentation website. Here's a demo of what that static site looks like: https://envoy-mobile-docc-demo.netlify.app/documentation/envoy/
envoy-mobile-docc.mp4
Risk Level: Low
Testing: Local, CI
Docs Changes: Added
Release Notes: Added
Signed-off-by: JP Simard jp@jpsim.com