1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
|
"""Docutils inline roles for CLI/argparse highlighting.
This module provides custom docutils roles for inline highlighting of CLI
elements in reStructuredText and MyST documentation.
Available roles:
- :cli-option: - CLI options (--verbose, -h)
- :cli-metavar: - Metavar placeholders (FILE, PATH)
- :cli-command: - Command names (sync, add)
- :cli-default: - Default values (None, "default")
- :cli-choice: - Choice values (json, yaml)
"""
from __future__ import annotations
import typing as t
from docutils import nodes
from docutils.parsers.rst import roles
if t.TYPE_CHECKING:
from docutils.parsers.rst.states import Inliner
def normalize_options(options: dict[str, t.Any] | None) -> dict[str, t.Any]:
"""Normalize role options, converting None to empty dict.
Parameters
----------
options : dict | None
Options passed to the role.
Returns
-------
dict
Normalized options dict (never None).
Examples
--------
>>> normalize_options(None)
{}
>>> normalize_options({"class": "custom"})
{'class': 'custom'}
"""
return options if options is not None else {}
def cli_option_role(
name: str,
rawtext: str,
text: str,
lineno: int,
inliner: Inliner | None,
options: dict[str, t.Any] | None = None,
content: list[str] | None = None,
) -> tuple[list[nodes.Node], list[nodes.system_message]]:
"""Role for CLI options like --foo or -h.
Generates a literal node with appropriate CSS classes for styling.
Long options (--foo) get 'cli-option-long', short options (-h) get
'cli-option-short'.
Parameters
----------
name : str
Local name of the role used in document.
rawtext : str
Full interpreted text including role markup.
text : str
Content between backticks.
lineno : int
Line number.
inliner : Inliner | None
Object that called the role (has .reporter, .document).
options : dict | None
Options from role directive.
content : list | None
Content from role directive.
Returns
-------
tuple[list[nodes.Node], list[nodes.system_message]]
Nodes to insert and any messages.
Examples
--------
>>> node_list, messages = cli_option_role(
... "cli-option", ":cli-option:`--verbose`", "--verbose",
... 1, None
... )
>>> node_list[0]["classes"]
['cli-option', 'cli-option-long']
>>> node_list, messages = cli_option_role(
... "cli-option", ":cli-option:`-h`", "-h",
... 1, None
... )
>>> node_list[0]["classes"]
['cli-option', 'cli-option-short']
>>> node_list, messages = cli_option_role(
... "cli-option", ":cli-option:`--no-color`", "--no-color",
... 1, None
... )
>>> node_list[0].astext()
'--no-color'
"""
options = normalize_options(options)
node = nodes.literal(rawtext, text, classes=["cli-option"])
if text.startswith("--"):
node["classes"].append("cli-option-long")
elif text.startswith("-"):
node["classes"].append("cli-option-short")
return [node], []
def cli_metavar_role(
name: str,
rawtext: str,
text: str,
lineno: int,
inliner: Inliner | None,
options: dict[str, t.Any] | None = None,
content: list[str] | None = None,
) -> tuple[list[nodes.Node], list[nodes.system_message]]:
"""Role for CLI metavar placeholders like FILE or PATH.
Generates a literal node with 'cli-metavar' CSS class for styling.
Parameters
----------
name : str
Local name of the role used in document.
rawtext : str
Full interpreted text including role markup.
text : str
Content between backticks.
lineno : int
Line number.
inliner : Inliner | None
Object that called the role.
options : dict | None
Options from role directive.
content : list | None
Content from role directive.
Returns
-------
tuple[list[nodes.Node], list[nodes.system_message]]
Nodes to insert and any messages.
Examples
--------
>>> node_list, messages = cli_metavar_role(
... "cli-metavar", ":cli-metavar:`FILE`", "FILE",
... 1, None
... )
>>> node_list[0]["classes"]
['cli-metavar']
>>> node_list[0].astext()
'FILE'
>>> node_list, messages = cli_metavar_role(
... "cli-metavar", ":cli-metavar:`PATH`", "PATH",
... 1, None
... )
>>> "cli-metavar" in node_list[0]["classes"]
True
"""
options = normalize_options(options)
node = nodes.literal(rawtext, text, classes=["cli-metavar"])
return [node], []
def cli_command_role(
name: str,
rawtext: str,
text: str,
lineno: int,
inliner: Inliner | None,
options: dict[str, t.Any] | None = None,
content: list[str] | None = None,
) -> tuple[list[nodes.Node], list[nodes.system_message]]:
"""Role for CLI command names like sync or add.
Generates a literal node with 'cli-command' CSS class for styling.
Parameters
----------
name : str
Local name of the role used in document.
rawtext : str
Full interpreted text including role markup.
text : str
Content between backticks.
lineno : int
Line number.
inliner : Inliner | None
Object that called the role.
options : dict | None
Options from role directive.
content : list | None
Content from role directive.
Returns
-------
tuple[list[nodes.Node], list[nodes.system_message]]
Nodes to insert and any messages.
Examples
--------
>>> node_list, messages = cli_command_role(
... "cli-command", ":cli-command:`sync`", "sync",
... 1, None
... )
>>> node_list[0]["classes"]
['cli-command']
>>> node_list[0].astext()
'sync'
>>> node_list, messages = cli_command_role(
... "cli-command", ":cli-command:`myapp`", "myapp",
... 1, None
... )
>>> "cli-command" in node_list[0]["classes"]
True
"""
options = normalize_options(options)
node = nodes.literal(rawtext, text, classes=["cli-command"])
return [node], []
def cli_default_role(
name: str,
rawtext: str,
text: str,
lineno: int,
inliner: Inliner | None,
options: dict[str, t.Any] | None = None,
content: list[str] | None = None,
) -> tuple[list[nodes.Node], list[nodes.system_message]]:
"""Role for CLI default values like None or "default".
Generates a literal node with 'cli-default' CSS class for styling.
Parameters
----------
name : str
Local name of the role used in document.
rawtext : str
Full interpreted text including role markup.
text : str
Content between backticks.
lineno : int
Line number.
inliner : Inliner | None
Object that called the role.
options : dict | None
Options from role directive.
content : list | None
Content from role directive.
Returns
-------
tuple[list[nodes.Node], list[nodes.system_message]]
Nodes to insert and any messages.
Examples
--------
>>> node_list, messages = cli_default_role(
... "cli-default", ":cli-default:`None`", "None",
... 1, None
... )
>>> node_list[0]["classes"]
['cli-default']
>>> node_list[0].astext()
'None'
>>> node_list, messages = cli_default_role(
... "cli-default", ':cli-default:`"auto"`', '"auto"',
... 1, None
... )
>>> "cli-default" in node_list[0]["classes"]
True
"""
options = normalize_options(options)
node = nodes.literal(rawtext, text, classes=["cli-default"])
return [node], []
def cli_choice_role(
name: str,
rawtext: str,
text: str,
lineno: int,
inliner: Inliner | None,
options: dict[str, t.Any] | None = None,
content: list[str] | None = None,
) -> tuple[list[nodes.Node], list[nodes.system_message]]:
"""Role for CLI choice values like json or yaml.
Generates a literal node with 'cli-choice' CSS class for styling.
Parameters
----------
name : str
Local name of the role used in document.
rawtext : str
Full interpreted text including role markup.
text : str
Content between backticks.
lineno : int
Line number.
inliner : Inliner | None
Object that called the role.
options : dict | None
Options from role directive.
content : list | None
Content from role directive.
Returns
-------
tuple[list[nodes.Node], list[nodes.system_message]]
Nodes to insert and any messages.
Examples
--------
>>> node_list, messages = cli_choice_role(
... "cli-choice", ":cli-choice:`json`", "json",
... 1, None
... )
>>> node_list[0]["classes"]
['cli-choice']
>>> node_list[0].astext()
'json'
>>> node_list, messages = cli_choice_role(
... "cli-choice", ":cli-choice:`yaml`", "yaml",
... 1, None
... )
>>> "cli-choice" in node_list[0]["classes"]
True
"""
options = normalize_options(options)
node = nodes.literal(rawtext, text, classes=["cli-choice"])
return [node], []
def register_roles() -> None:
"""Register all CLI roles with docutils.
This function registers the following roles:
- cli-option: For CLI options (--verbose, -h)
- cli-metavar: For metavar placeholders (FILE, PATH)
- cli-command: For command names (sync, add)
- cli-default: For default values (None, "default")
- cli-choice: For choice values (json, yaml)
Examples
--------
>>> register_roles()
>>> # Roles are now available in docutils RST parsing
"""
roles.register_local_role("cli-option", cli_option_role) # type: ignore[arg-type]
roles.register_local_role("cli-metavar", cli_metavar_role) # type: ignore[arg-type]
roles.register_local_role("cli-command", cli_command_role) # type: ignore[arg-type]
roles.register_local_role("cli-default", cli_default_role) # type: ignore[arg-type]
roles.register_local_role("cli-choice", cli_choice_role) # type: ignore[arg-type]
|
