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

[Doc] Fix broken references in serve documentation #45113

Merged

Conversation

peytondmurray
Copy link
Contributor

@peytondmurray peytondmurray commented May 2, 2024

Why are these changes needed?

This PR fixes broken links in Serve documentation in preparation for turning on Sphinx's nitpicky mode.

Related issue number

Partially addresses #39658.

Note: The version increase of autodoc_pydantic is needed to support @root_validator-decorated pydantic models, and is made possible by #40451.

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: pdmurray <peynmurray@gmail.com>
@peytondmurray peytondmurray force-pushed the docs-fix-serve-bad-links-39658 branch from f8cb14b to 4cfebf9 Compare May 2, 2024 19:17
@peytondmurray peytondmurray marked this pull request as ready for review May 2, 2024 19:20
@aslonnie aslonnie merged commit 4b7e1f7 into ray-project:master May 2, 2024
5 checks passed
@peytondmurray peytondmurray deleted the docs-fix-serve-bad-links-39658 branch May 2, 2024 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants