[Serve][Doc] Refactor the Ray Serve API doc #32307
Merged
Conversation
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
sihanwang41
force-pushed
the
doc_api
branch
2 times, most recently
from
cfc191f
to
c45d7f3
Compare
sihanwang41
added
release-blocker
Signed-off-by: Sihan Wang <[email protected]>
sihanwang41
requested review from
edoakes,
simon-mo,
jiaodong,
shrekris-anyscale,
architkulkarni and
a team
as code owners
edoakes
approved these changes
Feb 8, 2023
zcin
approved these changes
Feb 8, 2023
shrekris-anyscale
approved these changes
Feb 8, 2023
richardliaw
approved these changes
Feb 8, 2023
7 tasks
7 tasks
edoakes
pushed a commit
to edoakes/ray
that referenced
this pull request
Mar 22, 2023
- 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"> Signed-off-by: Edward Oakes <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Sihan Wang [email protected]
Why are these changes needed?
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.)Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.