Skip to content

[Docs] Fix some snippets #31378

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
DarkLight1337 merged 1 commit into from
Dec 26, 2025
Merged

[Docs] Fix some snippets #31378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/cli/bench/latency.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

## Arguments

--8<-- "docs/argparse/bench_latency.inc.md"
--8<-- "docs/generated/argparse/bench_latency.inc.md"
2 changes: 1 addition & 1 deletion docs/cli/bench/serve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

## Arguments

--8<-- "docs/argparse/bench_serve.inc.md"
--8<-- "docs/generated/argparse/bench_serve.inc.md"
2 changes: 1 addition & 1 deletion docs/cli/bench/sweep/plot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

## Arguments

--8<-- "docs/argparse/bench_sweep_plot.inc.md"
--8<-- "docs/generated/argparse/bench_sweep_plot.inc.md"
2 changes: 1 addition & 1 deletion docs/cli/bench/sweep/plot_pareto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

## Arguments

--8<-- "docs/argparse/bench_sweep_plot_pareto.inc.md"
--8<-- "docs/generated/argparse/bench_sweep_plot_pareto.inc.md"
2 changes: 1 addition & 1 deletion docs/cli/bench/sweep/serve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

## Arguments

--8<-- "docs/argparse/bench_sweep_serve.inc.md"
--8<-- "docs/generated/argparse/bench_sweep_serve.inc.md"
2 changes: 1 addition & 1 deletion docs/cli/bench/sweep/serve_sla.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

## Arguments

--8<-- "docs/argparse/bench_sweep_serve_sla.inc.md"
--8<-- "docs/generated/argparse/bench_sweep_serve_sla.inc.md"
2 changes: 1 addition & 1 deletion docs/cli/bench/throughput.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

## Arguments

--8<-- "docs/argparse/bench_throughput.inc.md"
--8<-- "docs/generated/argparse/bench_throughput.inc.md"
2 changes: 1 addition & 1 deletion docs/cli/chat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

## Arguments

--8<-- "docs/argparse/chat.inc.md"
--8<-- "docs/generated/argparse/chat.inc.md"
2 changes: 1 addition & 1 deletion docs/cli/complete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

## Arguments

--8<-- "docs/argparse/complete.inc.md"
--8<-- "docs/generated/argparse/complete.inc.md"
2 changes: 1 addition & 1 deletion docs/cli/run-batch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

## Arguments

--8<-- "docs/argparse/run-batch.inc.md"
--8<-- "docs/generated/argparse/run-batch.inc.md"
2 changes: 1 addition & 1 deletion docs/cli/serve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

## Arguments

--8<-- "docs/argparse/serve.inc.md"
--8<-- "docs/generated/argparse/serve.inc.md"
4 changes: 2 additions & 2 deletions docs/configuration/engine_args.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
2 changes: 1 addition & 1 deletion docs/mkdocs/hooks/generate_argparse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
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))

Expand Down
6 changes: 3 additions & 3 deletions docs/mkdocs/hooks/generate_metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@

# 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",
},
]

Expand Down
6 changes: 3 additions & 3 deletions docs/usage/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down