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.

Sign up for GitHub

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

Jump to bottom

Generate documentation from CapnP schema files #124

Open
tmcgilchrist opened this issue May 31, 2023 · 0 comments
Open

Generate documentation from CapnP schema files #124

tmcgilchrist opened this issue May 31, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@tmcgilchrist
Copy link
Member

The CapnP schema file represents the true API between ocaml-docs-ci and the consumers of it like cli tools or other services like ocaml.org website. It should be possible to generate HTML/markdown/mld documentation from the schema file.
Similar tools exist for gRPC / protobuf and we would like one to exist for CapnP.
@tmcgilchrist tmcgilchrist added documentation Improvements or additions to documentation enhancement New feature or request labels May 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tmcgilchrist