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

Sphinx documentation #709

Merged

Conversation

Bobbins228
Copy link
Contributor

@Bobbins228 Bobbins228 commented Oct 15, 2024

Issue link

Closes: RHOAIENG-13962 and RHOAIENG-9511

What changes have been made

includes changes from #698

  • Added Sphinx code documentation automation Work Flow
  • Added new documentation under Ray Cluster Interaction, UI Widgets and Cluster Configuration
  • Proven working workflow
  • Example of what the documentation will look like when the WF is run on main https://bobbins228.github.io/codeflare-sdk/

Verification steps

N/A

TODO

Change the GitHub Pages deployment to use the new gh-pages branch from root dir.
Run the Workflow

Checks

  • I've made sure the tests are passing.
  • Testing Strategy
    • Unit tests
    • Manual tests
    • Testing is not required for this change

Copy link

codecov bot commented Oct 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.99%. Comparing base (7c04444) to head (a921928).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #709   +/-   ##
=======================================
  Coverage   93.99%   93.99%           
=======================================
  Files          36       36           
  Lines        2364     2364           
=======================================
  Hits         2222     2222           
  Misses        142      142           

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

.github/workflows/publish-documentation.yaml Show resolved Hide resolved
docs/sphinx/user-docs/authentication.rst Outdated Show resolved Hide resolved
docs/sphinx/user-docs/authentication.rst Outdated Show resolved Hide resolved
docs/sphinx/user-docs/s3-compatible-storage.rst Outdated Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
@Bobbins228 Bobbins228 added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 15, 2024
.github/workflows/release.yaml Show resolved Hide resolved
.github/workflows/publish-documentation.yaml Show resolved Hide resolved
docs/sphinx/user-docs/cluster-configuration.rst Outdated Show resolved Hide resolved
docs/sphinx/user-docs/setup-kueue.rst Outdated Show resolved Hide resolved
@Bobbins228 Bobbins228 force-pushed the sphinx-documentation branch 2 times, most recently from f95ef2c to cc105d8 Compare October 16, 2024 11:58
@Bobbins228 Bobbins228 removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 17, 2024
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Oct 17, 2024
Copy link
Contributor

openshift-ci bot commented Oct 17, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: KPostOffice, Ygnas

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 17, 2024
@openshift-merge-bot openshift-merge-bot bot merged commit 9288016 into project-codeflare:main Oct 17, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants