Skip to content

Commit

Permalink
[Doc] Add setuptools dependency for building docs (ray-project#46375)
Browse files Browse the repository at this point in the history
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 ray-project#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

Signed-off-by: pdmurray <[email protected]>
  • Loading branch information
peytondmurray authored Jul 2, 2024
1 parent acf792e commit 1ccc22e
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .buildkite/build.rayci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ steps:
key: doc_build
instance_type: medium
commands:
- FAST=True make -C doc/ html
- make -C doc/ html
depends_on: docbuild
job_env: docbuild

Expand Down
4 changes: 2 additions & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
os: ubuntu-24.04
tools:
python: "3.11"
python: "3.12"

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand Down
3 changes: 3 additions & 0 deletions doc/requirements-doc.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Production requirements. This is what readthedocs.com picks up

# Required to build the docs on 3.12 due to pkg_resources deprecation
setuptools>=70.0.0

# Syntax highlighting
Pygments==2.16.1

Expand Down

0 comments on commit 1ccc22e

Please sign in to comment.