Skip to content

Commit 0422ce1

Browse files
authored
Add :markdownhelp: to EngineArgs docs so markdown docstrings render properly (#17124)
Signed-off-by: Harry Mellor <[email protected]>
1 parent 47bdee4 commit 0422ce1

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

docs/source/serving/engine_args.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Below, you can find an explanation of every engine argument:
1616
:func: _engine_args_parser
1717
:prog: vllm serve
1818
:nodefaultconst:
19+
:markdownhelp:
1920
```
2021

2122
## Async Engine Arguments
@@ -29,4 +30,5 @@ Additional arguments are available to the asynchronous engine which is used for
2930
:func: _async_engine_args_parser
3031
:prog: vllm serve
3132
:nodefaultconst:
33+
:markdownhelp:
3234
```

requirements/docs.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ sphinx-togglebutton==0.3.2
77
myst-parser==3.0.1
88
msgspec
99
cloudpickle
10+
commonmark # Required by sphinx-argparse when using :markdownhelp:
1011

1112
# packages to install to build the documentation
1213
cachetools

0 commit comments

Comments
 (0)