Bold options

Signed-off-by: Bernát Gábor <[email protected]>

Author: gaborbernat

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.4.0 (2021-02-14)
+
+- Command line arguments are now bold to highlight them even further from the help text
+
 ## 1.3.0 (2021-02-13)
 
 - Add support for changing the usage width via the `usage_width` option on the directive

src/sphinx_argparse_cli/_logic.py

@@ -25,6 +25,7 @@
     paragraph,
     reference,
     section,
+    strong,
     title,
 )
 from docutils.parsers.rst.directives import positive_int, unchanged, unchanged_required
@@ -145,22 +146,15 @@ def _mk_option_line(self, action: Action, prefix: str) -> list_item:  # noqa
                     first = False
                 else:
                     line += Text(", ")
-                ref_id = make_id(f"{prefix}-{opt}")
-                ref = reference("", refid=ref_id)
-                line.attributes["ids"].append(ref_id)
-                ref += literal(text=opt)
-                line += ref
+                self._mk_option_name(line, prefix, opt)
         else:
             as_key = (
                 action.dest
                 if action.metavar is None
                 else (action.metavar if isinstance(action.metavar, str) else action.metavar[0])
             )
-            ref_id = make_id(f"{prefix}-{as_key}")
-            ref = reference("", refid=ref_id)
-            line.attributes["ids"].append(ref_id)
-            ref += literal(text=as_key)
-            line += ref
+            self._mk_option_name(line, prefix, as_key)
+
         point = list_item("", line, ids=[])
         if action.help:
             help_text = load_help_text(action.help)
@@ -175,6 +169,16 @@ def _mk_option_line(self, action: Action, prefix: str) -> list_item:  # noqa
             line += Text(")")
         return point
 
+    @staticmethod
+    def _mk_option_name(line: paragraph, prefix: str, opt: str) -> None:
+        ref_id = make_id(f"{prefix}-{opt}")
+        ref = reference("", refid=ref_id)
+        line.attributes["ids"].append(ref_id)
+        st = strong()
+        st += literal(text=opt)
+        ref += st
+        line += ref
+
     def _mk_sub_command(self, aliases: list[str], help_msg: str, parser: ArgumentParser) -> section:
         title_text = f"{parser.prog}"
         if aliases:

tests/complex.txt

@@ -9,21 +9,21 @@ argparse tester
 optional arguments
 ==================
 
-* "-h", "--help" - show this help message and exit
+* **"-h"**, **"--help"** - show this help message and exit
 
-* "--root" - root flag (default: "False")
+* **"--root"** - root flag (default: "False")
 
-* "--no-help" (default: "False")
+* **"--no-help"** (default: "False")
 
 
 Exclusive
 =========
 
 this is an exclusive group
 
-* "--foo" - foo (default: "False")
+* **"--foo"** - foo (default: "False")
 
-* "--bar" - bar (default: "False")
+* **"--bar"** - bar (default: "False")
 
 
 complex first (f)
@@ -37,19 +37,19 @@ a-first-help
 complex first positional arguments
 ----------------------------------
 
-* "one" - first positional argument (default: "None")
+* **"one"** - first positional argument (default: "None")
 
-* "pos_two" - second positional argument (default: "1")
+* **"pos_two"** - second positional argument (default: "1")
 
 
 complex first optional arguments
 --------------------------------
 
-* "-h", "--help" - show this help message and exit
+* **"-h"**, **"--help"** - show this help message and exit
 
-* "--flag" - a parser first flag (default: "False")
+* **"--flag"** - a parser first flag (default: "False")
 
-* "--root" - root flag (default: "False")
+* **"--root"** - root flag (default: "False")
 
 
 complex second
@@ -61,19 +61,19 @@ complex second
 complex second positional arguments
 -----------------------------------
 
-* "one" - first positional argument (default: "None")
+* **"one"** - first positional argument (default: "None")
 
-* "pos_two" - second positional argument (default: "green")
+* **"pos_two"** - second positional argument (default: "green")
 
 
 complex second optional arguments
 ---------------------------------
 
-* "-h", "--help" - show this help message and exit
+* **"-h"**, **"--help"** - show this help message and exit
 
-* "--flag" - a parser second flag (default: "False")
+* **"--flag"** - a parser second flag (default: "False")
 
-* "--root" - root flag (default: "False")
+* **"--root"** - root flag (default: "False")
 
 
 complex third
@@ -85,4 +85,4 @@ complex third
 complex third optional arguments
 --------------------------------
 
-* "-h", "--help" - show this help message and exit
+* **"-h"**, **"--help"** - show this help message and exit