Skip to content

docs: Adding redirects #3965

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

Merged
nv-anants merged 2 commits into from
Oct 29, 2025
Merged

docs: Adding redirects #3965

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
996e76d
docs: Adding redirects
aschilling-nv Oct 29, 2025
2aa2756
docs: coderabbitai feedback
aschilling-nv Oct 29, 2025
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
6 changes: 6 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Comment thread
aschilling-nv marked this conversation as resolved.
## Dependency Management

Documentation dependencies are defined in `pyproject.toml` under the `[dependency-groups]` section:
Expand Down
17 changes: 17 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,23 @@
"sphinx_reredirects",
]

# Redirects configuration
redirects = {
"guides/tool-calling": "../agents/tool-calling.html", # key format corrected
Comment thread
nv-anants marked this conversation as resolved.
"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",
}
Comment thread
aschilling-nv marked this conversation as resolved.

# Custom extensions
sys.path.insert(0, os.path.abspath("_extensions"))
extensions.append("github_alerts")
Expand Down
Loading