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

Automatic documentation generation #360

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

Automatic documentation generation #360

andrewleech opened this issue Nov 8, 2024 · 0 comments

Comments

@andrewleech
Copy link

This feature suggestion was raised by @mattytrentini as we work on updates to the micropython / bindings integration.

The generated python functions all follow the underlying C functions, however there's some changes to structure and arguments with the use of python classes etc.
The C files in lvgl have docstrings.

It would be a really nice addition to the bindings generator if it also generated docs for the python files as it works, merging any docstrings from the C files into function definitions as generated for python. Bonus points for including links back to the original C files in the docs for each function / file.

This could also generate .pyi stub files that could be used for static typing / autocompletion in vscode etc.

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