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

Add doxygen API generation into our documentation #2624

Open
petejohanson opened this issue Nov 8, 2024 · 0 comments
Open

Add doxygen API generation into our documentation #2624

petejohanson opened this issue Nov 8, 2024 · 0 comments
Labels
core Core functionality/behavior of ZMK documentation Improvements or additions to documentation enhancement New feature or request github_actions Pull requests that update Github_actions code

Comments

@petejohanson
Copy link
Contributor

To keep our documentation in sync, we should document all public APIs ( see #2619 ) with proper doxygen annotations, and add a doxygen step to our documentation generation to integrate proper API docs into our site.

Needs:

  • Doxygen setup and generation
  • Enhance docusaurus to integrate doxygen generated pages as nicely as possible (research needed here)

Optional:

  • Add CI check (pre-commit? Something else?) for ensuring all public API types, functions, etc are properly documented?
@petejohanson petejohanson added documentation Improvements or additions to documentation enhancement New feature or request core Core functionality/behavior of ZMK github_actions Pull requests that update Github_actions code labels Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Core functionality/behavior of ZMK documentation Improvements or additions to documentation enhancement New feature or request github_actions Pull requests that update Github_actions code
Projects
None yet
Development

No branches or pull requests

1 participant