[serve] Clean up API reference and various docstrings (ray-project#34711

) Cleans up the API reference page formatting, adds/updates docstrings where applicable (corrects typing + verbiage, adds inline examples). Co-authored-by: Cindy Zhang <[email protected]> Co-authored-by: angelinalg <[email protected]>
architkulkarni · May 16, 2023 · b2e4e0d · b2e4e0d
1 parent 8064fea
commit b2e4e0d
Show file tree

Hide file tree

Showing 13 changed files with 611 additions and 551 deletions.
diff --git a/doc/source/_templates/autosummary/class_without_init_args.rst b/doc/source/_templates/autosummary/class_without_init_args.rst
@@ -0,0 +1,6 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}()
+    :members:
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -432,3 +432,8 @@ def setup(app):
 ]
 
 redoc_uri = "https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"
+
+autosummary_filename_map = {
+    "ray.serve.deployment": "ray.serve.deployment_decorator",
+    "ray.serve.Deployment": "ray.serve.Deployment",
+}