[serve] API reference docs are broken

[edoakes]

The API reference is not rendering properly on the docs for both master and 2.6 release branch. Example:
https://docs.ray.io/en/master/serve/api/index.html

[edoakes]

I'm seeing this in the doc build logs:

WARNING: [autosummary] failed to import 'ray.serve.Application': no module named ray.serve.Application
WARNING: [autosummary] failed to import 'ray.serve.Deployment': no module named ray.serve.Deployment
WARNING: [autosummary] failed to import 'ray.serve.air_integrations.PredictorWrapper': no module named ray.serve.air_integrations.PredictorWrapper
WARNING: [autosummary] failed to import 'ray.serve.batch': no module named ray.serve.batch
WARNING: [autosummary] failed to import 'ray.serve.delete': no module named ray.serve.delete
WARNING: [autosummary] failed to import 'ray.serve.deployment': no module named ray.serve.deployment
WARNING: [autosummary] failed to import 'ray.serve.get_replica_context': no module named ray.serve.get_replica_context
WARNING: [autosummary] failed to import 'ray.serve.handle.RayServeHandle': no module named ray.serve.handle.RayServeHandle
WARNING: [autosummary] failed to import 'ray.serve.handle.RayServeSyncHandle': no module named ray.serve.handle.RayServeSyncHandle
WARNING: [autosummary] failed to import 'ray.serve.ingress': no module named ray.serve.ingress
WARNING: [autosummary] failed to import 'ray.serve.run': no module named ray.serve.run
WARNING: [autosummary] failed to import 'ray.serve.schema.ApplicationDetails': no module named ray.serve.schema.ApplicationDetails
WARNING: [autosummary] failed to import 'ray.serve.schema.DeploymentDetails': no module named ray.serve.schema.DeploymentDetails
WARNING: [autosummary] failed to import 'ray.serve.schema.DeploymentSchema': no module named ray.serve.schema.DeploymentSchema
WARNING: [autosummary] failed to import 'ray.serve.schema.HTTPOptionsSchema': no module named ray.serve.schema.HTTPOptionsSchema
WARNING: [autosummary] failed to import 'ray.serve.schema.RayActorOptionsSchema': no module named ray.serve.schema.RayActorOptionsSchema
WARNING: [autosummary] failed to import 'ray.serve.schema.ReplicaDetails': no module named ray.serve.schema.ReplicaDetails
WARNING: [autosummary] failed to import 'ray.serve.schema.ServeApplicationSchema': no module named ray.serve.schema.ServeApplicationSchema
WARNING: [autosummary] failed to import 'ray.serve.schema.ServeDeploySchema': no module named ray.serve.schema.ServeDeploySchema
WARNING: [autosummary] failed to import 'ray.serve.schema.ServeInstanceDetails': no module named ray.serve.schema.ServeInstanceDetails
WARNING: [autosummary] failed to import 'ray.serve.schema.ServeStatusSchema': no module named ray.serve.schema.ServeStatusSchema
WARNING: [autosummary] failed to import 'ray.serve.shutdown': no module named ray.serve.shutdown
WARNING: [autosummary] failed to import 'ray.serve.start': no module named ray.serve.start
Failed to import 'ray.serve.http_adapters': no module named ray.serve.http_adapters

[edoakes]

Looks like #37128 is the offending PR.

API ref from the previous PR build (#37072): https://anyscale-ray--37072.com.readthedocs.build/en/37072/serve/api/index.html

API ref from that PR build (#37128): https://anyscale-ray--37128.com.readthedocs.build/en/37128/serve/api/index.html

[edoakes]

Opening a revert PR to verify that it would fix the issue: #37338

[edoakes]

Revert commit did not seem to fix the issue: https://anyscale-ray--37338.com.readthedocs.build/en/37338/serve/api/index.html

[edoakes]

Now manually diffing the logs of the two builds. So far the only difference is the fastapi version changed from fastapi-0.99.1 in the working build to fastapi-0.100.0 in the broken one.

Kicking off a build with the fastapi version pinned to see if it fixes the issue: #37340.

[edoakes]

For reference:

(anyscale) eoakes@Edwards-MacBook-Pro-2 Downloads % git diff --word-diff working.txt broken.txt
diff --git a/working.txt b/broken.txt
index 966bee9..8278409 100644
--- a/working.txt
+++ b/broken.txt
@@ -1 +1 @@
Successfully installed GitPython-3.1.31 Jinja2-3.0.3 PyWavelets-1.3.0 Pygments-2.13.0 Send2Trash-1.8.2 absl-py-1.4.0 accelerate-0.20.3 aiohttp-3.8.4 aiosignal-1.3.1 anyio-3.7.1 appdirs-1.4.4 argon2-cffi-21.3.0 argon2-cffi-bindings-21.2.0 asgiref-3.7.2 astunparse-1.6.3 async-timeout-4.0.2 asynctest-0.13.0 attrs-21.4.0 autodoc_pydantic-1.6.1 backcall-0.2.0 beautifulsoup4-4.12.2 bleach-6.0.0 cachetools-5.3.1 cffi-1.15.1 click-8.1.4 colorama-0.4.6 colorful-0.5.5 debugpy-1.6.7 decorator-5.1.1 defusedxml-0.7.1 dill-0.3.6 dm-tree-0.1.8 docker-pycreds-0.4.0 docutils-0.17.1 entrypoints-0.4 etils-0.9.0 exceptiongroup-1.1.2 fairscale-0.4.6 [-fastapi-0.99.1-]{+fastapi-0.100.0+} fastjsonschema-2.17.1 filelock-3.12.2 flask-2.2.5 flatbuffers-23.5.26 frozenlist-1.3.3 fsspec-2023.1.0 gast-0.4.0 gitdb-4.0.10 google-auth-2.21.0 google-auth-oauthlib-0.4.6 google-pasta-0.2.0 googleapis-common-protos-1.59.1 greenlet-2.0.2 grpcio-1.51.3 h11-0.14.0 h5py-3.8.0 huggingface-hub-0.16.4 imageio-2.31.1 importlib-resources-5.12.0 ipykernel-6.16.2 ipython-7.34.0 ipython-genutils-0.2.0 ipywidgets-7.7.5 itsdangerous-2.1.2 jedi-0.18.2 joblib-1.3.1 jsonpointer-2.4 jsonschema-4.17.3 jupyter-cache-0.4.3 jupyter-client-7.4.9 jupyter-core-4.12.0 jupyter-server-1.24.0 jupyter-server-mathjax-0.2.6 jupyter-sphinx-0.3.2 jupyterlab-pygments-0.2.2 jupyterlab-widgets-1.1.4 jupytext-1.13.6 keras-2.11.0 libclang-16.0.0 lightgbm-3.3.5 lightgbm-ray-0.1.9 lxml-4.9.3 markdown-3.4.3 markdown-it-py-1.1.0 matplotlib-inline-0.1.6 mdit-py-plugins-0.2.8 mistune-0.8.4 msgpack-1.0.5 multidict-6.0.4 myst-nb-0.13.1 myst-parser-0.15.2 nbclassic-1.0.0 nbclient-0.5.13 nbconvert-6.5.4 nbdime-3.2.1 nbformat-5.8.0 nest-asyncio-1.5.6 networkx-2.6.3 notebook-6.5.4 notebook-shim-0.2.3 numpy-1.21.6 nvidia-cublas-cu11-11.10.3.66 nvidia-cuda-nvrtc-cu11-11.7.99 nvidia-cuda-runtime-cu11-11.7.99 nvidia-cudnn-cu11-8.5.0.96 oauthlib-3.2.2 opt-einsum-3.3.0 pandas-1.3.5 pandocfilters-1.5.0 parso-0.8.3 pathtools-0.1.2 pexpect-4.8.0 pickle5-0.0.12 pickleshare-0.7.5 pkgutil-resolve-name-1.3.10 prometheus-client-0.17.0 promise-2.3 prompt-toolkit-3.0.39 protobuf-3.19.6 psutil-5.9.5 ptyprocess-0.7.0 pyDeprecate-0.3.2 pyaml-23.5.8 pyarrow-12.0.1 pyasn1-0.5.0 pyasn1-modules-0.3.0 pycparser-2.21 pydantic-1.9.2 pydata-sphinx-theme-0.8.1 pyrsistent-0.19.3 python-dateutil-2.8.2 pytorch-lightning-1.6.5 pyyaml-6.0 pyzmq-25.1.0 ray-2.5.1 redis-4.6.0 regex-2023.6.3 requests-oauthlib-1.3.1 rsa-4.9 safetensors-0.3.1 scikit-image-0.19.3 scikit-learn-1.0.2 scikit-optimize-0.9.0 scipy-1.7.3 sentry-sdk-1.27.1 setproctitle-1.3.2 six-1.16.0 smmap-5.0.0 sniffio-1.3.0 soupsieve-2.4.1 sphinx-4.3.2 sphinx-book-theme-0.3.3 sphinx-click-3.0.2 sphinx-copybutton-0.4.0 sphinx-external-toc-0.2.4 sphinx-jsonschema-1.17.2 sphinx-remove-toctrees-0.0.3 sphinx-sitemap-2.2.0 sphinx-tabs-3.4.0 sphinx-togglebutton-0.2.3 sphinx-version-warning-1.1.2 sphinx_design-0.4.1 sphinxcontrib-redoc-1.6.0 sphinxemoji-0.2.0 sqlalchemy-1.4.49 starlette-0.27.0 tensorboard-2.11.2 tensorboard-data-server-0.6.1 tensorboard-plugin-wit-1.8.1 tensorboardX-2.6 tensorflow-2.11.0 tensorflow-datasets-4.8.2 tensorflow-estimator-2.11.0 tensorflow-io-gcs-filesystem-0.32.0 tensorflow-metadata-1.12.0 termcolor-2.3.0 terminado-0.17.1 threadpoolctl-3.1.0 tifffile-2021.11.2 tinycss2-1.2.1 tokenizers-0.13.3 toml-0.10.2 torch-1.13.1 torchmetrics-0.11.4 torchvision-0.14.1 tornado-6.2 tqdm-4.65.0 traitlets-5.9.0 transformers-4.30.2 tune-sklearn-0.4.6 urllib3-1.26.16 uvicorn-0.16.0 wandb-0.15.5 wcwidth-0.2.6 webencodings-0.5.1 websocket-client-1.6.1 werkzeug-2.2.3 widgetsnbextension-3.6.4 wrapt-1.15.0 xgboost-1.6.2 xgboost_ray-0.1.17 yarl-1.9.2

[bveeramani]

Fixed by #37354