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

add accelerator docs #4713

Closed
wants to merge 2 commits into from
Closed

add accelerator docs #4713

wants to merge 2 commits into from

Conversation

cosmicBboy
Copy link
Contributor

This PR adds accelerator docs to the monodocs toctree.

Signed-off-by: Niels Bantilan <[email protected]>
@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jan 10, 2024
Copy link

codecov bot commented Jan 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (ac42562) 58.13% compared to head (0d47441) 58.14%.
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4713   +/-   ##
=======================================
  Coverage   58.13%   58.14%           
=======================================
  Files         626      626           
  Lines       53786    53786           
=======================================
+ Hits        31271    31276    +5     
+ Misses      20007    20002    -5     
  Partials     2508     2508           
Flag Coverage Δ
unittests 58.14% <ø> (+<0.01%) ⬆️

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.

@cosmicBboy cosmicBboy enabled auto-merge (squash) January 10, 2024 15:53
Signed-off-by: Niels Bantilan <[email protected]>
Copy link
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like flyte needs to be manually updated when a new top level document is added to flytekit. Can docs/reference_flytekit.md be generated from something checked into from flytekit?

@cosmicBboy
Copy link
Contributor Author

This looks like flyte needs to be manually updated when a new top level document is added to flytekit. Can docs/reference_flytekit.md be generated from something checked into from flytekit?

Yeah we can add a new top-level index page to flytekit instead of flyte, this PR is just a stop-gap

Copy link
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The failing CI test looks related. Is this expected?

@cosmicBboy
Copy link
Contributor Author

The failing CI test looks related. Is this expected?

Hmm, I think because of b35f792 the build process is using the latest stable release (which doesn't have the accelerator docs).

Might just opt for doing the right thing here.

@thomasjpfan
Copy link
Member

I am closing this PR because the issue was resolved in #4720

auto-merge was automatically disabled January 20, 2024 18:38

Pull request was closed

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 size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants