Skip to content

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

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
merged 1 commit into from
Apr 24, 2025
Merged

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

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: 2 additions & 0 deletions docs/source/serving/engine_args.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
```
1 change: 1 addition & 0 deletions requirements/docs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down