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] Add V2 ReadTheDocs config #37590

Merged
merged 2 commits into from
Jul 19, 2023

Conversation

bveeramani
Copy link
Member

Why are these changes needed?

The Read the Docs build system will start requiring a configuration file v2 (.readthedocs.yaml) starting on September 25, 2023. To prevent documentation build failures, this PR updates our configuration.

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
Copy link
Contributor

@matthewdeng matthewdeng left a comment

Choose a reason for hiding this comment

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

Awesome!

@richardliaw
Copy link
Contributor

nice work! i've tried this a couple times and it has never worked on master before, so let's just make sure we check in on this after merging.

@matthewdeng
Copy link
Contributor

PR build succeeds, will verify in master.


via GIPHY

@matthewdeng matthewdeng merged commit c35a6aa into ray-project:master Jul 19, 2023
20 of 127 checks passed
angelinalg pushed a commit to angelinalg/ray that referenced this pull request Jul 22, 2023
Bhav00 pushed a commit to Bhav00/ray that referenced this pull request Jul 24, 2023
bveeramani added a commit that referenced this pull request Jul 24, 2023
* [Docs] Add V2 ReadTheDocs config (#37590)



Signed-off-by: Balaji Veeramani <[email protected]>

* turn on fail-on-warning for Sphinx builds (#37651)

Signed-off-by: angelinalg <[email protected]>

---------

Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: angelinalg <[email protected]>
Co-authored-by: Balaji Veeramani <[email protected]>
Bhav00 pushed a commit to Bhav00/ray that referenced this pull request Jul 28, 2023
NripeshN pushed a commit to NripeshN/ray that referenced this pull request Aug 15, 2023
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: NripeshN <[email protected]>
harborn pushed a commit to harborn/ray that referenced this pull request Aug 17, 2023
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: harborn <[email protected]>
harborn pushed a commit to harborn/ray that referenced this pull request Aug 17, 2023
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: e428265 <[email protected]>
vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Victor <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants