-
Notifications
You must be signed in to change notification settings - Fork 659
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
[Docs] API reference for pyflyte #2888
Comments
Use sphinx click to generate CLI reference docs See here for example usage |
#self-assign |
I'm a first time contributor, is this a good first issue? |
Yeah, it should be. If this is difficult, we'll consider it as 2 PRs. |
I am willing to work on this issue as Hacktoberfest participant. |
Hello I want to contribute to this issue. I am having a lot of troubles, the documentation doesn't make it clear where & how to run the workflow of documentation building (to my knowledge, please reference it) locally, neither does it give specific locations for API reference to |
@adicoder95 Are you working on it? |
@Azanul yes, but facing lots of trouble. That's why taking time. |
@adicoder95 In which parts are you facing issues? I might be able to help |
The changes need to be made in the flytekit directory. The API docs should be rendered here. For reference, take a look at how the other pages are being rendered and the formatting needed. |
Description
Need API references for
pyflyte
init, local-cache, package, register, run, and serializeAre you sure this issue hasn't been raised already?
Have you read the Code of Conduct?
The text was updated successfully, but these errors were encountered: