Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable Swift-DocC plugin for generating docs #1262

Merged
merged 2 commits into from
Aug 2, 2022

Conversation

tbkka
Copy link
Collaborator

@tbkka tbkka commented Aug 2, 2022

I'm going to be going through things and updating our API docs and articles to work cleanly with DocC. First step is to make it easier to build and view the docs.

With this, you can build and view the docs for a single part of our project with:

% swift package --disable-sandbox preview-documentation --target SwiftProtobuf   

This should also work for --target protoc-gen-swift, --target SwiftProtobufPluginLibrary, and --target Conformance.

@tbkka tbkka requested a review from thomasvl August 2, 2022 14:54
Copy link
Collaborator

@thomasvl thomasvl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we document how to do any of this? Is it worth running any sorta CI to catch issue with source comments/etc?

Showing my ignorance, how does this compare to xcodebuild docbuild? (https://developer.apple.com/documentation/xcode/distributing-documentation-to-external-developers)

@thomasvl
Copy link
Collaborator

thomasvl commented Aug 2, 2022

I guess I'm also sorta think of #1154 and #1032, should we start linking to other things and maybe dropping the jazzy info in the repo?

@tbkka
Copy link
Collaborator Author

tbkka commented Aug 2, 2022

This uses exactly the same tools as xcodebuild docbuild and should produce identical results. The only difference is that it will work on non-Apple platforms.

I don't think we're ready to drop Jazzy support just yet. I plan to spend some time over the next few weeks trying to clean up and improve the DocC docs.

@thomasvl
Copy link
Collaborator

thomasvl commented Aug 2, 2022

I plan to spend some time over the next few weeks trying to clean up and improve the DocC docs.

Great! You might want to self assign those two issues then to let folks know things are being worked on.

@tbkka tbkka merged commit 4e5dd86 into apple:main Aug 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants