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

Auto-generate CLI and config docs from code #219

Open
Johennes opened this issue Feb 12, 2025 · 0 comments
Open

Auto-generate CLI and config docs from code #219

Johennes opened this issue Feb 12, 2025 · 0 comments

Comments

@Johennes
Copy link
Collaborator

We currently manually maintain the documentation of CLI flags and config options under docs/. For CLI flags we're additionally duplicating this information in the code (see e.g. https://github.com/jhugman/uniffi-bindgen-react-native/blob/main/crates/ubrn_cli/src/ios.rs#L116) so that clap can use it. It would be great if we could organize this data in one place. Preferably it would be the code because then we cannot forget to update the docs after changing the code.

Options we could consider for generating docs from the code include https://github.com/ConnorGray/clap-markdown or maybe even just cargo doc with some light script processing.

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

No branches or pull requests

1 participant