forked from ray-project/ray
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Serve][Doc] Refactor the Ray Serve API doc (ray-project#32307)
- Add an index page to list all the APIs. (https://ray--32307.org.readthedocs.build/en/32307/serve/api/index.html) - With this change, when you search specific python API e.g`ray.serve.run`. The search result will show core api link page. (Previously, the user can't get the correct search result, because we put all APIs on one page.) <img width="604" alt="image" src="https://user-images.githubusercontent.com/6515354/217628692-720b9344-061d-44de-bc77-ee0c0ef27276.png">
- Loading branch information
1 parent
3bb73d3
commit 22bc1e9
Showing
7 changed files
with
63 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
(serve-api)= | ||
# Ray Serve API | ||
|
||
```{toctree} | ||
:maxdepth: '-1' | ||
python_api | ||
rest_api | ||
serve_cli | ||
``` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Ray Serve Python API | ||
|
||
(core-apis)= | ||
|
||
```{eval-rst} | ||
.. currentmodule:: ray | ||
``` | ||
|
||
## Core APIs | ||
|
||
```{eval-rst} | ||
.. autosummary:: | ||
:toctree: doc/ | ||
serve.run | ||
serve.start | ||
serve.shutdown | ||
serve.delete | ||
``` | ||
|
||
(servehandle-api)= | ||
## ServeHandle API | ||
|
||
```{eval-rst} | ||
.. autosummary:: | ||
:toctree: doc/ | ||
serve.handle.RayServeHandle | ||
serve.handle.RayServeHandle.remote | ||
serve.handle.RayServeHandle.options | ||
``` | ||
|
||
## Batching Requests | ||
|
||
```{eval-rst} | ||
.. autosummary:: | ||
:toctree: doc/ | ||
serve.batch | ||
``` | ||
|
||
## Deployment Graph APIs | ||
|
||
```{eval-rst} | ||
.. autosummary:: | ||
:toctree: doc/ | ||
serve.api.build | ||
``` |
File renamed without changes.
File renamed without changes.
This file was deleted.
Oops, something went wrong.