diff --git a/.readthedocs.yaml b/.readthedocs.yaml deleted file mode 100644 index 86d349aa334a..000000000000 --- a/.readthedocs.yaml +++ /dev/null @@ -1,20 +0,0 @@ -# .readthedocs.yaml -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required -version: 2 - -# Build documentation in the docs/ directory with Sphinx -sphinx: - configuration: doc/source/conf.py - -# Optionally build your docs in additional formats such as PDF -formats: - - pdf - -# Optionally set the version of Python and requirements required to build your docs -python: - version: 3.7 - install: - - requirements: doc/requirements-doc.txt diff --git a/ci/travis/install-dependencies.sh b/ci/travis/install-dependencies.sh index 11817f5399a2..d448faf9a82b 100755 --- a/ci/travis/install-dependencies.sh +++ b/ci/travis/install-dependencies.sh @@ -319,6 +319,7 @@ install_dependencies() { if [ "${OSTYPE}" = msys ] && [ "${python_version}" = "3.8" ]; then { echo "WARNING: Pillow binaries not available on Windows; cannot build docs"; } 2> /dev/null else + pip install --use-deprecated=legacy-resolver -r "${WORKSPACE_DIR}"/doc/requirements-rtd.txt pip install --use-deprecated=legacy-resolver -r "${WORKSPACE_DIR}"/doc/requirements-doc.txt fi fi diff --git a/doc/requirements-doc.txt b/doc/requirements-doc.txt index 7b279127ebc1..125af34b4015 100644 --- a/doc/requirements-doc.txt +++ b/doc/requirements-doc.txt @@ -1,27 +1,22 @@ -alabaster>=0.7,<0.8,!=0.7.5 click colorama colorful -commonmark==0.8.1 -docutils==0.15 filelock flask flatbuffers fastapi jsonschema -mock==1.0.1 +mock numpy opencv-python-headless==4.3.0.36 pandas pickle5 -pillow==7.2.0 +pillow pydantic -Pygments==2.3.1 +pygments pyyaml -readthedocs-sphinx-ext<1.1 -recommonmark==0.5.0 +recommonmark redis -setuptools==41.0.1 sphinx==3.0.4 sphinx-click sphinx-copybutton @@ -30,7 +25,7 @@ sphinx-gallery sphinx-jsonschema sphinx-tabs sphinx-version-warning -sphinx-book-theme==0.0.42 +sphinx-book-theme sphinxcontrib.yt starlette tabulate diff --git a/doc/requirements-rtd.txt b/doc/requirements-rtd.txt new file mode 100644 index 000000000000..fd8835daf881 --- /dev/null +++ b/doc/requirements-rtd.txt @@ -0,0 +1,11 @@ +Pygments==2.3.1 +setuptools==41.0.1 +docutils==0.15 +mock==1.0.1 +pillow==7.2.0 +alabaster>=0.7,<0.8,!=0.7.5 +commonmark==0.8.1 +recommonmark==0.5.0 +sphinx==3.0.4 +readthedocs-sphinx-ext<1.1 +sphinx-book-theme==0.0.42 diff --git a/doc/source/development.rst b/doc/source/development.rst index 7494077220c3..b3b7102e058a 100644 --- a/doc/source/development.rst +++ b/doc/source/development.rst @@ -183,21 +183,14 @@ correctly. `Sphinx `_ is used to generate the documentat .. code-block:: shell cd doc - conda create -n ray-docs pip python=3.7 # optional, but very useful. pip install -r requirements-doc.txt + pip install -U -r requirements-rtd.txt # important for reproducing the deployment environment make html Once done, the docs will be in ``doc/_build/html``. For example, on Mac OSX, you can open the docs (assuming you are still in the ``doc`` directory) using ``open _build/html/index.html``. -All pull requests will also build a copy of the documentation as part of the CI. -A successful build will have the following check on the build matrix: - -.. code-block:: shell - - docs/readthedocs.org:ray — Read the Docs build succeeded! - Using a local repository for dependencies -----------------------------------------