xinyun/vllm
1
0
Fork 0
mirror of https://git.datalinker.icu/vllm-project/vllm.git synced 2025-12-14 06:55:01 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
This commit is contained in:
Harry Mellor 2025-04-24 18:28:45 +01:00 committed by GitHub
parent 47bdee409c
commit 0422ce109f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/serving/engine_args.md
View File

@ -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
:func: _async_engine_args_parser :func: _async_engine_args_parser
:prog: vllm serve :prog: vllm serve
:nodefaultconst: :nodefaultconst:
:markdownhelp:
``` ```

1
requirements/docs.txt
View File

@ -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