From 996e76d6f2ca6acb6de03a1b17a4a06846f57c90 Mon Sep 17 00:00:00 2001 From: Andrew Schilling Date: Wed, 29 Oct 2025 19:35:25 +0000 Subject: [PATCH 1/2] docs: Adding redirects Signed-off-by: Andrew Schilling --- docs/README.md | 6 ++++++ docs/conf.py | 17 +++++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/docs/README.md b/docs/README.md index 9d1f30bbb225..2bcabc2d9deb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -68,6 +68,12 @@ This approach is ideal for CI/CD pipelines or when you want complete isolation f - `docs/_extensions/` - Custom Sphinx extensions - `docs/build/` - Generated documentation output (not tracked in git) +## Redirect Creation + +When moving or renaming files a redirect must be created. + +The logic for redirect creation is located [here](https://documatt.com/sphinx-reredirects/usage/#introduction) and should be added to the existing list in the conf.py. + ## Dependency Management Documentation dependencies are defined in `pyproject.toml` under the `[dependency-groups]` section: diff --git a/docs/conf.py b/docs/conf.py index a65aa94f1329..1a8a01b31bc8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -33,6 +33,23 @@ "sphinx_reredirects", ] +# Redirects configuration +redirects = { + "guides/tool-calling.html": "../agents/tool-calling.html", # relative + "architecture/architecture.html": "../design_docs/architecture.html", # relative + "architecture/disagg_serving.html": "../design_docs/disagg_serving.html", # relative + "architecture/distributed_runtime.html": "../design_docs/distributed_runtime.html", # relative + "architecture/dynamo_flow.html": "../design_docs/dynamo_flow.html", # relative + "architecture/request_cancellation.html": "../fault_tolerance/request_cancellation.html", # relative + "architecture/request_migration.html": "../fault_tolerance/request_migration.html", # relative + "kubernetes/create_deployment.html": "../kubernetes/deployment/create_deployment.html", # relative + "kubernetes/minikube.html": "../kubernetes/deployment/minikube.html", # relative + "kubernetes/multinode-deployment.html": "../kubernetes/deployment/multinode-deployment.html", # relative + "kubernetes/logging.html": "../kubernetes/observability/logging.html", # relative + "kubernetes/metrics.html": "../kubernetes/observability/metrics.html", # relative + "architecture/kv_cache_routing.html": "../router/kv_cache_routing.html", # relative +} + # Custom extensions sys.path.insert(0, os.path.abspath("_extensions")) extensions.append("github_alerts") From 2aa2756ca502877e9c9cd9d2a34f22a9c6e84c82 Mon Sep 17 00:00:00 2001 From: Andrew Schilling Date: Wed, 29 Oct 2025 20:07:52 +0000 Subject: [PATCH 2/2] docs: coderabbitai feedback Signed-off-by: Andrew Schilling --- docs/README.md | 2 +- docs/conf.py | 26 +++++++++++++------------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/README.md b/docs/README.md index 2bcabc2d9deb..a7b987293241 100644 --- a/docs/README.md +++ b/docs/README.md @@ -72,7 +72,7 @@ This approach is ideal for CI/CD pipelines or when you want complete isolation f When moving or renaming files a redirect must be created. -The logic for redirect creation is located [here](https://documatt.com/sphinx-reredirects/usage/#introduction) and should be added to the existing list in the conf.py. +Redirect entries should be added to the `redirects` dictionary in `conf.py`. For detailed information on redirect syntax, see the [sphinx-reredirects usage documentation](https://documatt.com/sphinx-reredirects/usage/#introduction). ## Dependency Management diff --git a/docs/conf.py b/docs/conf.py index 1a8a01b31bc8..05b52d0bb6bf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -35,19 +35,19 @@ # Redirects configuration redirects = { - "guides/tool-calling.html": "../agents/tool-calling.html", # relative - "architecture/architecture.html": "../design_docs/architecture.html", # relative - "architecture/disagg_serving.html": "../design_docs/disagg_serving.html", # relative - "architecture/distributed_runtime.html": "../design_docs/distributed_runtime.html", # relative - "architecture/dynamo_flow.html": "../design_docs/dynamo_flow.html", # relative - "architecture/request_cancellation.html": "../fault_tolerance/request_cancellation.html", # relative - "architecture/request_migration.html": "../fault_tolerance/request_migration.html", # relative - "kubernetes/create_deployment.html": "../kubernetes/deployment/create_deployment.html", # relative - "kubernetes/minikube.html": "../kubernetes/deployment/minikube.html", # relative - "kubernetes/multinode-deployment.html": "../kubernetes/deployment/multinode-deployment.html", # relative - "kubernetes/logging.html": "../kubernetes/observability/logging.html", # relative - "kubernetes/metrics.html": "../kubernetes/observability/metrics.html", # relative - "architecture/kv_cache_routing.html": "../router/kv_cache_routing.html", # relative + "guides/tool-calling": "../agents/tool-calling.html", # key format corrected + "architecture/architecture": "../design_docs/architecture.html", + "architecture/disagg_serving": "../design_docs/disagg_serving.html", + "architecture/distributed_runtime": "../design_docs/distributed_runtime.html", + "architecture/dynamo_flow": "../design_docs/dynamo_flow.html", + "architecture/request_cancellation": "../fault_tolerance/request_cancellation.html", + "architecture/request_migration": "../fault_tolerance/request_migration.html", + "kubernetes/create_deployment": "../kubernetes/deployment/create_deployment.html", + "kubernetes/minikube": "../kubernetes/deployment/minikube.html", + "kubernetes/multinode-deployment": "../kubernetes/deployment/multinode-deployment.html", + "kubernetes/logging": "../kubernetes/observability/logging.html", + "kubernetes/metrics": "../kubernetes/observability/metrics.html", + "architecture/kv_cache_routing": "../router/kv_cache_routing.html", } # Custom extensions