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 API docs #43

Open
kewisch opened this issue Sep 21, 2024 · 2 comments
Open

Auto generate API docs #43

kewisch opened this issue Sep 21, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@kewisch
Copy link
Member

kewisch commented Sep 21, 2024

It would be useful if we can generate API docs on github pages for the APIs we have in this repo, this way we have a good overview of what is supported in the latest version.

@kewisch kewisch added the enhancement New feature or request label Sep 21, 2024
@jobisoft
Copy link
Collaborator

This would overlap with my project to rewrite our Phython schema-to-markdown-to-readthedocs script as a node script. I cannot say however when I get to it, but would be interested to collaborate in efforts in that direction.

@kewisch
Copy link
Member Author

kewisch commented Sep 21, 2024

Yeah, I was betting you have something in store. Where does the python script live? We could run that in a GH action as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants