Skip to content

docs: Fixing Sphinx errors casued by structural problems #3152

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
merged 6 commits into from
Sep 22, 2025
Merged

docs: Fixing Sphinx errors casued by structural problems #3152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
127fe58
muting Sphinx errors by adding topics to hidden_toc
kmkelle-nv Sep 19, 2025
c6618b3
Fixing Sphinx errors by adding topics to toc
kmkelle-nv Sep 19, 2025
d05f128
correcting nonsequential headings
kmkelle-nv Sep 19, 2025
5e56ba4
Merge branch 'main' into docs-kkelle-fix-sphinx-errors
nv-nmailhot Sep 19, 2025
ecd75ab
Merge branch 'main' into docs-kkelle-fix-sphinx-errors
nv-nmailhot Sep 22, 2025
1868bbc
Merge branch 'main' into docs-kkelle-fix-sphinx-errors
kmkelle-nv Sep 22, 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
8 changes: 4 additions & 4 deletions docs/guides/health_check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ the service is running.

> **Note**: Frontend liveness doesn't depend on worker health or liveness only on the Frontend service itself.

#### Example Request
### Example Request

```
curl -s localhost:8080/live -q | jq
```

#### Example Response
### Example Response

```
{
Expand All @@ -41,13 +41,13 @@ the service is running. Once workers have been registered, the

> **Note**: Frontend liveness doesn't depend on worker health or liveness only on the Frontend service itself.

#### Example Request
### Example Request

```
curl -v localhost:8080/health -q | jq
```

#### Example Response
### Example Response

Before workers are registered:

Expand Down
8 changes: 6 additions & 2 deletions docs/hidden_toctree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,24 @@
API/nixl_connect/write_operation.md
API/nixl_connect/README.md

guides/dynamo_deploy/api_reference.md
guides/dynamo_deploy/create_deployment.md
guides/dynamo_deploy/sla_planner_deployment.md

guides/dynamo_deploy/fluxcd.md
guides/dynamo_deploy/gke_setup.md
guides/dynamo_deploy/grove.md
guides/dynamo_deploy/k8s_metrics.md
guides/dynamo_deploy/model_caching_with_fluid.md
guides/dynamo_deploy/README.md
guides/dynamo_run.md
guides/dynamo_deploy/sla_planner_deployment.md
guides/metrics.md
guides/run_kvbm_in_vllm.md
guides/run_kvbm_in_trtllm.md

architecture/kv_cache_routing.md
architecture/load_planner.md
architecture/request_migration.md
architecture/request_cancellation.md

components/backends/trtllm/multinode/multinode-examples.md
components/backends/sglang/docs/multinode-examples.md
Expand Down
5 changes: 5 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Quickstart
:caption: Kubernetes Deployment

Quickstart (K8s) <../guides/dynamo_deploy/README.md>
Detailed Installation Guide <../guides/dynamo_deploy/installation_guide.md>
Dynamo Operator <../guides/dynamo_deploy/dynamo_operator.md>
Metrics <../guides/dynamo_deploy/metrics.md>
Logging <../guides/dynamo_deploy/logging.md>
Expand All @@ -70,6 +71,10 @@ Quickstart
:hidden:
:caption: Developer Guide

Benchmarking Guide <benchmarks/benchmarking.md>
Planner Benchmark Example <guides/planner_benchmark/README.md>
Logging <guides/logging.md>
Health Checks <guides/health_check.md>
Tuning Disaggregated Serving Performance <guides/disagg_perf_tuning.md>
Writing Python Workers in Dynamo <guides/backend.md>
Glossary <dynamo_glossary.md>
Loading