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

Regenerate flytectl docs #5914

Merged
merged 2 commits into from
Dec 6, 2024
Merged

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Oct 24, 2024

Why are the changes needed?

Not a high priority, but while working on flyte docs overhaul stuff, I noticed the flytectl docs were quite stale, so I regenerated them.

What changes were proposed in this pull request?

Updated flytectl docs, plus requirements files for running the regeneration script, which invokes Sphinx.

How was this patch tested?

Tested locally.

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

N/A

Docs link

https://flyte--5914.org.readthedocs.build/en/5914/api/flytectl/docs_index.html

nikki everett added 2 commits October 24, 2024 17:11
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
@neverett neverett requested a review from ppiegaze October 24, 2024 22:29
@neverett neverett self-assigned this Oct 24, 2024
Copy link

codecov bot commented Oct 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.82%. Comparing base (8bd573e) to head (ab160f7).
Report is 93 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #5914       +/-   ##
===========================================
+ Coverage   18.30%   36.82%   +18.52%     
===========================================
  Files         380     1309      +929     
  Lines       53948   130938    +76990     
===========================================
+ Hits         9873    48217    +38344     
- Misses      43238    78537    +35299     
- Partials      837     4184     +3347     
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.03% <ø> (?)
unittests-flytecopilot 11.73% <ø> (ø)
unittests-flytectl 62.40% <ø> (ø)
unittests-flyteidl 6.92% <ø> (ø)
unittests-flyteplugins 53.64% <ø> (?)
unittests-flytepropeller 43.00% <ø> (?)
unittests-flytestdlib 55.41% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@eapolinario eapolinario merged commit ffa1672 into master Dec 6, 2024
54 checks passed
@eapolinario eapolinario deleted the nikki/docs/regenerate-flytectl-docs branch December 6, 2024 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants