Skip to content

docs: generate api docs #1

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

Merged
merged 1 commit into from
Apr 18, 2025
Merged

docs: generate api docs #1

merged 1 commit into from
Apr 18, 2025

Conversation

watt
Copy link
Collaborator

@watt watt commented Apr 5, 2025

Adds DocC generated API docs as a CI job on main, published here.

This job uses a new feature of DocC to merge modules with a landing page. The inter-module symbol links don't work yet; I think maybe there's just no way to enable that in xcodebuild docbuild. But the joined navigation and landing page are a huge improvement.

Checklist

  • Unit Tests
  • Documentation
  • Pull request title follows conventional commits

@watt watt force-pushed the awatt/doc-gen branch 5 times, most recently from 8cc747e to 66a2e21 Compare April 5, 2025 01:40
@watt watt force-pushed the awatt/doc-gen branch 2 times, most recently from 13e19fe to 8f3b895 Compare April 17, 2025 02:05
@watt watt marked this pull request as ready for review April 17, 2025 22:32
@watt watt requested a review from a team as a code owner April 17, 2025 22:32
Copy link

@johnnewman-square johnnewman-square left a comment

Choose a reason for hiding this comment

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

The combined doc navigation for multiple targets is great.

@watt watt merged commit d060bea into main Apr 18, 2025
3 checks passed
@watt watt deleted the awatt/doc-gen branch April 18, 2025 22:36
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