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

[Doc] Add setuptools dependency for building docs #46375

Merged

Conversation

peytondmurray
Copy link
Contributor

Why are these changes needed?

This PR:

  • Adds a temporary setuptools>=70.0.0 dependency for building the docs to make sphinxcontrib-redoc usable on Python 3.12. This is not intended to be a long term solution, so [Doc] Remove setuptools dependency; find upgrade path for sphinxcontrib-redoc #46374 has been made to track the follow-up work.
  • Remove unused environment variable in the buildkite job that builds docs
  • Bump the os version and python version used to build the docs on RTD

Related issue number

Closes #46205.

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: pdmurray <peynmurray@gmail.com>
@peytondmurray peytondmurray added the docs An issue or change related to documentation label Jul 2, 2024
@peytondmurray peytondmurray requested a review from a team as a code owner July 2, 2024 06:42
@can-anyscale can-anyscale enabled auto-merge (squash) July 2, 2024 18:42
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Jul 2, 2024
@can-anyscale can-anyscale merged commit 1ccc22e into ray-project:master Jul 2, 2024
7 checks passed
@peytondmurray peytondmurray deleted the 46205-add-setuptools-doc-dep branch July 7, 2024 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs An issue or change related to documentation go add ONLY when ready to merge, run all tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Cannot build docs: No module named 'pkg_resources'
2 participants