Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
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.

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.

Comment thread
aschilling-nv marked this conversation as resolved.
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
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Comment thread
aschilling-nv marked this conversation as resolved.
Resolved

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