A high-throughput and memory-efficient inference and serving engine for LLMs
Mirrored from https://github.com/tduncan-lum/Nvidia-Optimization-Stack---VLLM.git
Synced Nov 9, 12:30 UTC
[Docs] Use definition lists for CLI reference docs (#33186)
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Co-authored-by: Ashwin Phadke <23502062+ashwin-phadke@users.noreply.github.com>
Harry Mellor committed
Jan 28, 2026 at 02:22 UTC
706f123b23b75097da9a3f51ce538bd784fdc75b
2 files changed
+9
-8
docs/mkdocs/hooks/generate_argparse.py
+8
-8
@@ -4,6 +4,7 @@ import importlib.metadata
4
import importlib.util
5
import logging
6
import sys
7
+import textwrap
8
import traceback
9
from argparse import SUPPRESS, Action, HelpFormatter
10
from collections.abc import Iterable
@@ -152,22 +153,21 @@ class MarkdownFormatter(HelpFormatter):
153
heading_md = f"{self._argument_heading_prefix} {option_strings}\n\n"
154
self._markdown_output.append(heading_md)
155
155
- if choices := action.choices:
156
- choices = f"`{'`, `'.join(str(c) for c in choices)}`"
157
- self._markdown_output.append(f"Possible choices: {choices}\n\n")
158
- elif (metavar := action.metavar) and isinstance(metavar, (list, tuple)):
159
- metavar = f"`{'`, `'.join(str(m) for m in metavar)}`"
160
- self._markdown_output.append(f"Possible choices: {metavar}\n\n")
156
+ if action.choices or isinstance(action.metavar, (list, tuple)):
157
+ choices_iterable = action.choices or action.metavar
158
+ choices = f"`{'`, `'.join(str(c) for c in choices_iterable)}`"
159
+ self._markdown_output.append(f": Possible choices: {choices}\n\n")
160
161
if action.help:
163
- self._markdown_output.append(f"{action.help}\n\n")
162
+ help_dd = ":" + textwrap.indent(action.help, " ")[1:]
163
+ self._markdown_output.append(f"{help_dd}\n\n")
164
165
# None usually means the default is determined at runtime
166
if (default := action.default) != SUPPRESS and default is not None:
167
# Make empty string defaults visible
168
if default == "":
169
default = '""'
170
- self._markdown_output.append(f"Default: `{default}`\n\n")
170
+ self._markdown_output.append(f": Default: `{default}`\n\n")
171
172
def format_help(self):
173
"""Return the formatted help as markdown."""
mkdocs.yaml
+1
@@ -108,6 +108,7 @@ plugins:
108
109
markdown_extensions:
110
- attr_list
111
+ - def_list
112
- md_in_html
113
- admonition
114
- pymdownx.details