From 0b544e6476eb88c3c011522c1feea6f16edf7022 Mon Sep 17 00:00:00 2001 From: Harry Mellor <19981378+hmellor@users.noreply.github.com> Date: Fri, 26 Dec 2025 12:47:41 +0000 Subject: [PATCH] [Docs] Fix some snippets (#31378) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> --- docs/cli/bench/latency.md | 2 +- docs/cli/bench/serve.md | 2 +- docs/cli/bench/sweep/plot.md | 2 +- docs/cli/bench/sweep/plot_pareto.md | 2 +- docs/cli/bench/sweep/serve.md | 2 +- docs/cli/bench/sweep/serve_sla.md | 2 +- docs/cli/bench/throughput.md | 2 +- docs/cli/chat.md | 2 +- docs/cli/complete.md | 2 +- docs/cli/run-batch.md | 2 +- docs/cli/serve.md | 2 +- docs/configuration/engine_args.md | 4 ++-- docs/mkdocs/hooks/generate_argparse.py | 2 +- docs/mkdocs/hooks/generate_metrics.py | 6 +++--- docs/usage/metrics.md | 6 +++--- 15 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/cli/bench/latency.md b/docs/cli/bench/latency.md index ea7ea7321f..9e1b905339 100644 --- a/docs/cli/bench/latency.md +++ b/docs/cli/bench/latency.md @@ -6,4 +6,4 @@ ## Arguments ---8<-- "docs/argparse/bench_latency.inc.md" +--8<-- "docs/generated/argparse/bench_latency.inc.md" diff --git a/docs/cli/bench/serve.md b/docs/cli/bench/serve.md index f7dc8036cc..792c6e094b 100644 --- a/docs/cli/bench/serve.md +++ b/docs/cli/bench/serve.md @@ -6,4 +6,4 @@ ## Arguments ---8<-- "docs/argparse/bench_serve.inc.md" +--8<-- "docs/generated/argparse/bench_serve.inc.md" diff --git a/docs/cli/bench/sweep/plot.md b/docs/cli/bench/sweep/plot.md index a101330e09..d7dc65e6df 100644 --- a/docs/cli/bench/sweep/plot.md +++ b/docs/cli/bench/sweep/plot.md @@ -6,4 +6,4 @@ ## Arguments ---8<-- "docs/argparse/bench_sweep_plot.inc.md" +--8<-- "docs/generated/argparse/bench_sweep_plot.inc.md" diff --git a/docs/cli/bench/sweep/plot_pareto.md b/docs/cli/bench/sweep/plot_pareto.md index f5dc257ce6..13dffd7f2b 100644 --- a/docs/cli/bench/sweep/plot_pareto.md +++ b/docs/cli/bench/sweep/plot_pareto.md @@ -6,4 +6,4 @@ ## Arguments ---8<-- "docs/argparse/bench_sweep_plot_pareto.inc.md" +--8<-- "docs/generated/argparse/bench_sweep_plot_pareto.inc.md" diff --git a/docs/cli/bench/sweep/serve.md b/docs/cli/bench/sweep/serve.md index f0468f06fc..6a8182feb4 100644 --- a/docs/cli/bench/sweep/serve.md +++ b/docs/cli/bench/sweep/serve.md @@ -6,4 +6,4 @@ ## Arguments ---8<-- "docs/argparse/bench_sweep_serve.inc.md" +--8<-- "docs/generated/argparse/bench_sweep_serve.inc.md" diff --git a/docs/cli/bench/sweep/serve_sla.md b/docs/cli/bench/sweep/serve_sla.md index 5642ec67eb..688d64f0bc 100644 --- a/docs/cli/bench/sweep/serve_sla.md +++ b/docs/cli/bench/sweep/serve_sla.md @@ -6,4 +6,4 @@ ## Arguments ---8<-- "docs/argparse/bench_sweep_serve_sla.inc.md" +--8<-- "docs/generated/argparse/bench_sweep_serve_sla.inc.md" diff --git a/docs/cli/bench/throughput.md b/docs/cli/bench/throughput.md index e7f618fb4d..66434c8781 100644 --- a/docs/cli/bench/throughput.md +++ b/docs/cli/bench/throughput.md @@ -6,4 +6,4 @@ ## Arguments ---8<-- "docs/argparse/bench_throughput.inc.md" +--8<-- "docs/generated/argparse/bench_throughput.inc.md" diff --git a/docs/cli/chat.md b/docs/cli/chat.md index 0246bd431b..7b8e718f62 100644 --- a/docs/cli/chat.md +++ b/docs/cli/chat.md @@ -2,4 +2,4 @@ ## Arguments ---8<-- "docs/argparse/chat.inc.md" +--8<-- "docs/generated/argparse/chat.inc.md" diff --git a/docs/cli/complete.md b/docs/cli/complete.md index eb2ffdaaba..65d953a7c0 100644 --- a/docs/cli/complete.md +++ b/docs/cli/complete.md @@ -2,4 +2,4 @@ ## Arguments ---8<-- "docs/argparse/complete.inc.md" +--8<-- "docs/generated/argparse/complete.inc.md" diff --git a/docs/cli/run-batch.md b/docs/cli/run-batch.md index 758fbda283..f2255e6637 100644 --- a/docs/cli/run-batch.md +++ b/docs/cli/run-batch.md @@ -6,4 +6,4 @@ ## Arguments ---8<-- "docs/argparse/run-batch.inc.md" +--8<-- "docs/generated/argparse/run-batch.inc.md" diff --git a/docs/cli/serve.md b/docs/cli/serve.md index 35652fec58..0326fe29ec 100644 --- a/docs/cli/serve.md +++ b/docs/cli/serve.md @@ -6,4 +6,4 @@ ## Arguments ---8<-- "docs/argparse/serve.inc.md" +--8<-- "docs/generated/argparse/serve.inc.md" diff --git a/docs/configuration/engine_args.md b/docs/configuration/engine_args.md index 05d4f76230..1458947882 100644 --- a/docs/configuration/engine_args.md +++ b/docs/configuration/engine_args.md @@ -15,8 +15,8 @@ The engine argument classes, [EngineArgs][vllm.engine.arg_utils.EngineArgs] and ## `EngineArgs` ---8<-- "docs/argparse/engine_args.md" +--8<-- "docs/generated/argparse/engine_args.inc.md" ## `AsyncEngineArgs` ---8<-- "docs/argparse/async_engine_args.md" +--8<-- "docs/generated/argparse/async_engine_args.inc.md" diff --git a/docs/mkdocs/hooks/generate_argparse.py b/docs/mkdocs/hooks/generate_argparse.py index 4ae64a6e4b..3baa4d817d 100644 --- a/docs/mkdocs/hooks/generate_argparse.py +++ b/docs/mkdocs/hooks/generate_argparse.py @@ -17,7 +17,7 @@ from pydantic_core import core_schema logger = logging.getLogger("mkdocs") ROOT_DIR = Path(__file__).parent.parent.parent.parent -ARGPARSE_DOC_DIR = ROOT_DIR / "docs/argparse" +ARGPARSE_DOC_DIR = ROOT_DIR / "docs/generated/argparse" sys.path.insert(0, str(ROOT_DIR)) diff --git a/docs/mkdocs/hooks/generate_metrics.py b/docs/mkdocs/hooks/generate_metrics.py index b20d43c4b2..9cbf635994 100644 --- a/docs/mkdocs/hooks/generate_metrics.py +++ b/docs/mkdocs/hooks/generate_metrics.py @@ -13,14 +13,14 @@ GENERATED_METRICS_DIR = DOCS_DIR / "generated" / "metrics" # Files to scan for metric definitions - each will generate a separate table METRIC_SOURCE_FILES = [ - {"path": "vllm/v1/metrics/loggers.py", "output": "general.md"}, + {"path": "vllm/v1/metrics/loggers.py", "output": "general.inc.md"}, { "path": "vllm/v1/spec_decode/metrics.py", - "output": "spec_decode.md", + "output": "spec_decode.inc.md", }, { "path": "vllm/distributed/kv_transfer/kv_connector/v1/nixl_connector.py", - "output": "nixl_connector.md", + "output": "nixl_connector.inc.md", }, ] diff --git a/docs/usage/metrics.md b/docs/usage/metrics.md index 829533b843..421d5df4a0 100644 --- a/docs/usage/metrics.md +++ b/docs/usage/metrics.md @@ -35,15 +35,15 @@ The following metrics are exposed: ## General Metrics ---8<-- "docs/generated/metrics/general.md" +--8<-- "docs/generated/metrics/general.inc.md" ## Speculative Decoding Metrics ---8<-- "docs/generated/metrics/spec_decode.md" +--8<-- "docs/generated/metrics/spec_decode.inc.md" ## NIXL KV Connector Metrics ---8<-- "docs/generated/metrics/nixl_connector.md" +--8<-- "docs/generated/metrics/nixl_connector.inc.md" ## Deprecation Policy