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

feat: support zig documentation generation #223

Merged
merged 13 commits into from
Feb 13, 2024
Merged

feat: support zig documentation generation #223

merged 13 commits into from
Feb 13, 2024

Conversation

aherrmann
Copy link
Owner

Closes #221

Adds support to generate documentation using Zig's autodoc feature.

  • Generate documentation in dedicated output group
  • Factor out documentation generation
  • Document the zig_docs output group
  • e2e test for Zig documentation
  • e2e test for Zig docs guide
  • Add extra_docs attribute for user guides
  • Pass guide.md in extra_docs attribute
  • Fix autodoc file not found error
  • Add a doctest

@aherrmann aherrmann enabled auto-merge February 13, 2024 19:31
@aherrmann aherrmann merged commit 5442ad0 into main Feb 13, 2024
@aherrmann aherrmann deleted the runfiles branch February 13, 2024 20:02
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.

Support generating documentation
1 participant