Skip to content

[docs][serve] Fix Serve LLM examples sidebar doc links 404 #64209

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.

Sign up for GitHub

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

Open
ryankert01 wants to merge 1 commit into
base: master
Choose a base branch
from
+117 −3
Open

[docs][serve] Fix Serve LLM examples sidebar doc links 404 #64209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
94 changes: 91 additions & 3 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import html
import io
import json
import logging
Expand Down Expand Up @@ -273,6 +274,37 @@ def _urlopen_read_with_retries(url, timeout):
},
}

_DEPLOYMENT_SERVE_LLM_COLLECTION = (
"_collections/serve/tutorials/deployment-serve-llm"
)
_DEPLOYMENT_SERVE_LLM_TUTORIALS = (
"small-size-llm",
"medium-size-llm",
"large-size-llm",
"vision-llm",
"reasoning-llm",
"hybrid-reasoning-llm",
"gpt-oss",
)
_DEPLOYMENT_SERVE_LLM_TUTORIAL_RE = "|".join(
re.escape(name) for name in _DEPLOYMENT_SERVE_LLM_TUTORIALS
)
_DEPLOYMENT_SERVE_LLM_DOC_URL_RE = re.compile(
"https://docs\\.ray\\.io/en/[^/]+/"
"serve/tutorials/deployment-serve-llm/"
f"(?:content/)?(?P<tutorial>{_DEPLOYMENT_SERVE_LLM_TUTORIAL_RE})"
"(?:/content)?/README\\.html"
)
Comment thread
ryankert01 marked this conversation as resolved.
_DEPLOYMENT_SERVE_LLM_LEGACY_REDIRECTS = {
legacy: f"{_DEPLOYMENT_SERVE_LLM_COLLECTION}/{tutorial}/README.html"
for tutorial in _DEPLOYMENT_SERVE_LLM_TUTORIALS
for legacy in (
f"serve/tutorials/deployment-serve-llm/{tutorial}/README.html",
f"serve/tutorials/deployment-serve-llm/content/{tutorial}/README.html",
f"serve/tutorials/deployment-serve-llm/content/{tutorial}/content/README.html",
)
}


def _resolve_template_url(name):
"""Fetch the build zip URL for a template from the channel API."""
Expand Down Expand Up @@ -331,6 +363,56 @@ def _fetch_and_extract_zip(config):
shutil.rmtree(target, ignore_errors=True)


def _rewrite_deployment_serve_llm_links(source: str, docname: str) -> str:
relative_docname = docname.removeprefix(
f"{_DEPLOYMENT_SERVE_LLM_COLLECTION}/"
)
parent_depth = len(pathlib.PurePosixPath(relative_docname).parent.parts)
relative_prefix = "../" * parent_depth
return _DEPLOYMENT_SERVE_LLM_DOC_URL_RE.sub(
lambda match: f"{relative_prefix}{match.group('tutorial')}/README.md",
source,
)
Comment thread
cursor[bot] marked this conversation as resolved.


def _redirect_html(target_url: str) -> str:
escaped_target = html.escape(target_url, quote=True)
js_target = json.dumps(target_url)
return f"""<!doctype html>
<html>
<head>
<meta charset="utf-8">
<title>Redirecting...</title>
<link rel="canonical" href="{escaped_target}">
<meta http-equiv="refresh" content="0; url={escaped_target}">
<script>
window.location.replace({js_target} + window.location.hash);
</script>
</head>
<body>
<p>Redirecting to <a href="{escaped_target}">{escaped_target}</a>.</p>
</body>
</html>
"""
Comment thread
ryankert01 marked this conversation as resolved.


def write_legacy_template_redirects(app, exception):
if exception is not None or app.builder.format != "html":
return

outdir = pathlib.Path(app.outdir)
for legacy_path, target_path in _DEPLOYMENT_SERVE_LLM_LEGACY_REDIRECTS.items():
target_file = outdir / target_path
if not target_file.exists():
continue

redirect_file = outdir / legacy_path
redirect_file.parent.mkdir(parents=True, exist_ok=True)
relative_target = os.path.relpath(target_file, redirect_file.parent)
relative_target = relative_target.replace(os.sep, "/")
redirect_file.write_text(_redirect_html(relative_target), encoding="utf-8")


collections = {
name: {
"driver": "function",
Expand Down Expand Up @@ -968,11 +1050,17 @@ def mark_orphans(app, docname, _source):
# lines render as shell.
_MAGIC_CODE_BLOCK_RE = re.compile(r"```python\n((?:#[^\n]*\n)*)([!%]\S)")

def fix_collections_code_blocks(app, docname, source):
def fix_collections_markdown(app, docname, source):
if docname.startswith("_collections/"):
source[0] = _MAGIC_CODE_BLOCK_RE.sub(r"```ipython3\n\1\2", source[0])

app.connect('source-read', fix_collections_code_blocks)
if (
docname.startswith(f"{_DEPLOYMENT_SERVE_LLM_COLLECTION}/")
and docname.endswith("/README")
):
source[0] = _rewrite_deployment_serve_llm_links(source[0], docname)

app.connect('source-read', fix_collections_markdown)
app.connect("build-finished", write_legacy_template_redirects)

app.add_config_value("ipython3_lexer_patterns", [], "env")
app.add_config_value("ipython3_lexer_exclude_patterns", [], "env")
Expand Down
26 changes: 26 additions & 0 deletions doc/source/custom_directives.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,31 @@
.split("\n")
)

_LEGACY_COLLECTION_HREF_REWRITES = (
(
"serve/tutorials/deployment-serve-llm/content/",
"_collections/serve/tutorials/deployment-serve-llm/",
),
(
"serve/tutorials/deployment-serve-llm/",
"_collections/serve/tutorials/deployment-serve-llm/",
),
)
_DEPLOYMENT_SERVE_LLM_COLLECTION_PREFIX = (
"_collections/serve/tutorials/deployment-serve-llm/"
)


def canonicalize_collection_href(href: str) -> str:
"""Map legacy in-tree template links to fetched _collections pages."""
for old_prefix, new_prefix in _LEGACY_COLLECTION_HREF_REWRITES:
if href.startswith(old_prefix):
href = new_prefix + href[len(old_prefix) :]
break
if href.startswith(_DEPLOYMENT_SERVE_LLM_COLLECTION_PREFIX):
href = href.replace("/content/README.html", "/README.html")
return href
Comment thread
ryankert01 marked this conversation as resolved.


def feedback_form_url(project, page):
"""Create a URL for feedback on a particular page in a project."""
Expand Down Expand Up @@ -350,6 +375,7 @@ def preload_sidebar_nav(

for a in soup.select("a"):
absolute_href = re.sub(r"^(\.\.\/)*", "", a["href"])
absolute_href = canonicalize_collection_href(absolute_href)
a["href"] = to_root_prefix + absolute_href

if absolute_href == f"{pagename}.html":
Expand Down
Loading