Unverified Commit 0422ce10 authored by Harry Mellor's avatar Harry Mellor Committed by GitHub
Browse files

Add `:markdownhelp:` to `EngineArgs` docs so markdown docstrings render properly (#17124)


Signed-off-by: default avatarHarry Mellor <19981378+hmellor@users.noreply.github.com>
parent 47bdee40
...@@ -16,6 +16,7 @@ Below, you can find an explanation of every engine argument: ...@@ -16,6 +16,7 @@ Below, you can find an explanation of every engine argument:
:func: _engine_args_parser :func: _engine_args_parser
:prog: vllm serve :prog: vllm serve
:nodefaultconst: :nodefaultconst:
:markdownhelp:
``` ```
## Async Engine Arguments ## Async Engine Arguments
...@@ -29,4 +30,5 @@ Additional arguments are available to the asynchronous engine which is used for ...@@ -29,4 +30,5 @@ Additional arguments are available to the asynchronous engine which is used for
:func: _async_engine_args_parser :func: _async_engine_args_parser
:prog: vllm serve :prog: vllm serve
:nodefaultconst: :nodefaultconst:
:markdownhelp:
``` ```
...@@ -7,6 +7,7 @@ sphinx-togglebutton==0.3.2 ...@@ -7,6 +7,7 @@ sphinx-togglebutton==0.3.2
myst-parser==3.0.1 myst-parser==3.0.1
msgspec msgspec
cloudpickle cloudpickle
commonmark # Required by sphinx-argparse when using :markdownhelp:
# packages to install to build the documentation # packages to install to build the documentation
cachetools cachetools
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment