Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Serve][Doc] Refactor the Ray Serve API doc #32341

Merged
merged 1 commit into from
Feb 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/source/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ parts:
- file: serve/tutorials/deployment-graph-patterns/linear_pipeline
- file: serve/tutorials/deployment-graph-patterns/branching_input
- file: serve/tutorials/deployment-graph-patterns/conditional
- file: serve/package-ref
- file: serve/api/index

- file: rllib/index
title: Ray RLlib
Expand Down
2 changes: 1 addition & 1 deletion doc/source/ray-references/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ API References
../data/api/api.rst
../train/api.rst
../tune/api_docs/overview.rst
../serve/package-ref.rst
../serve/api/index.rst
../rllib/package_ref/index.rst
../workflows/api/api.rst
../cluster/package-overview.rst
Expand Down
12 changes: 12 additions & 0 deletions doc/source/serve/api/index.md
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
```


49 changes: 49 additions & 0 deletions doc/source/serve/api/python_api.md
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.
71 changes: 0 additions & 71 deletions doc/source/serve/package-ref.md

This file was deleted.