From 0422ce109f3b4d80df073a542bd23d2c4b060873 Mon Sep 17 00:00:00 2001 From: Harry Mellor <19981378+hmellor@users.noreply.github.com> Date: Thu, 24 Apr 2025 18:28:45 +0100 Subject: [PATCH] Add `:markdownhelp:` to `EngineArgs` docs so markdown docstrings render properly (#17124) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> --- docs/source/serving/engine_args.md | 2 ++ requirements/docs.txt | 1 + 2 files changed, 3 insertions(+) diff --git a/docs/source/serving/engine_args.md b/docs/source/serving/engine_args.md index e9943571a4..97ea01cd3b 100644 --- a/docs/source/serving/engine_args.md +++ b/docs/source/serving/engine_args.md @@ -16,6 +16,7 @@ Below, you can find an explanation of every engine argument: :func: _engine_args_parser :prog: vllm serve :nodefaultconst: + :markdownhelp: ``` ## Async Engine Arguments @@ -29,4 +30,5 @@ Additional arguments are available to the asynchronous engine which is used for :func: _async_engine_args_parser :prog: vllm serve :nodefaultconst: + :markdownhelp: ``` diff --git a/requirements/docs.txt b/requirements/docs.txt index 99fb87def6..d84fd633ce 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -7,6 +7,7 @@ sphinx-togglebutton==0.3.2 myst-parser==3.0.1 msgspec cloudpickle +commonmark # Required by sphinx-argparse when using :markdownhelp: # packages to install to build the documentation cachetools