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

[Docs] API reference for pyflyte #2888

Closed
2 tasks done
Tracked by #2917
SmritiSatyanV opened this issue Sep 16, 2022 · 10 comments · Fixed by flyteorg/flytekit#1362
Closed
2 tasks done
Tracked by #2917

[Docs] API reference for pyflyte #2888

SmritiSatyanV opened this issue Sep 16, 2022 · 10 comments · Fixed by flyteorg/flytekit#1362
Labels
documentation Improvements or additions to documentation hacktoberfest

Comments

@SmritiSatyanV
Copy link
Contributor

Description

Need API references for pyflyte init, local-cache, package, register, run, and serialize

Are you sure this issue hasn't been raised already?

  • Yes

Have you read the Code of Conduct?

  • Yes
@SmritiSatyanV SmritiSatyanV added documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers labels Sep 16, 2022
@cosmicBboy
Copy link
Contributor

Use sphinx click to generate CLI reference docs

See here for example usage

@rithvikshetty
Copy link

#self-assign

@rithvikshetty
Copy link

rithvikshetty commented Oct 4, 2022

I'm a first time contributor, is this a good first issue?
@cosmicBboy @samhita-alla

@samhita-alla
Copy link
Contributor

Yeah, it should be. If this is difficult, we'll consider it as 2 PRs.

@adicoder95
Copy link

I am willing to work on this issue as Hacktoberfest participant.
can you assign to me

@eapolinario eapolinario removed the untriaged This issues has not yet been looked at by the Maintainers label Oct 14, 2022
@Devolta05
Copy link

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 pyflyte & conflicts with flytectl. It is very confusing with respect to the flow of documentation & code. Kindly allow for more information. Thank you

@Azanul
Copy link

Azanul commented Oct 23, 2022

@adicoder95 Are you working on it?

@adicoder95
Copy link

@Azanul yes, but facing lots of trouble. That's why taking time.

@Azanul
Copy link

Azanul commented Oct 23, 2022

@adicoder95 In which parts are you facing issues? I might be able to help

@samhita-alla
Copy link
Contributor

samhita-alla commented Oct 24, 2022

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.
@Devolta05 / @adicoder95

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest
Projects
None yet
Development

Successfully merging a pull request may close this issue.

8 participants