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] turn on fail-on-warning for Sphinx builds #37651

Merged
merged 2 commits into from
Jul 22, 2023

Conversation

angelinalg
Copy link
Contributor

We are missing build failures that Sphinx issues warnings for. This flag causes the ReadTheDocs build to fail if Sphinx issues warnings.
cc: @matthewdeng @edoakes @akshay-anyscale @rickyyx @zhe-thoughts

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 :(

@rickyyx
Copy link
Contributor

rickyyx commented Jul 21, 2023

How could we test it?

@rickyyx
Copy link
Contributor

rickyyx commented Jul 21, 2023

I guess need to merge this first? #37628

@matthewdeng
Copy link
Contributor

I guess need to merge this first? #37628

Yeah, for the build to pass.

How could we test it?

The fact that the job failed in this PR shows that the change is working as expected. 😄

image

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!

@matthewdeng matthewdeng merged commit 6098a0c into ray-project:master Jul 22, 2023
2 checks passed
@angelinalg angelinalg deleted the sphinx-fail-on-warning branch July 22, 2023 01:00
angelinalg added a commit to angelinalg/ray that referenced this pull request Jul 22, 2023
@edoakes
Copy link
Contributor

edoakes commented Jul 24, 2023

Thanks a lot for following up on this @angelinalg

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]>
NripeshN pushed a commit to NripeshN/ray that referenced this pull request Aug 15, 2023
harborn pushed a commit to harborn/ray that referenced this pull request Aug 17, 2023
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
vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023
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.

5 participants