Unverified Commit 7b709c41 authored by Andrew Schilling's avatar Andrew Schilling Committed by GitHub
Browse files

docs: Adding redirects (#3965)


Signed-off-by: default avatarAndrew Schilling <aschilling@nvidia.com>
parent d9e8d334
......@@ -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.
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
Documentation dependencies are defined in `pyproject.toml` under the `[dependency-groups]` section:
......
......@@ -33,6 +33,23 @@ extensions = [
"sphinx_reredirects",
]
# Redirects configuration
redirects = {
"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
sys.path.insert(0, os.path.abspath("_extensions"))
extensions.append("github_alerts")
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment