Added escape for Sphinx characters to default value

Author: RobertoRoos

sphinxarg/ext.py

@@ -142,10 +142,9 @@ def print_action_groups(data, nested_content, markdown_help=False, settings=None
                     '"==SUPPRESS=="',
                     '==SUPPRESS==',
                 ]:
-                    if entry['default'] == '':
-                        arg.append('Default: ""')
-                    else:
-                        arg.append(f"Default: {entry['default']}")
+                    # Put the default value in a literal block - but escape backticks already in the string
+                    default_str = str(entry['default']).replace('`', '\`')
+                    arg.append(f"Default: ``{default_str}``")
 
                 # Handle nested content, the term used in the dict has the comma removed for simplicity
                 desc = arg

sphinxarg/parser.py

@@ -111,7 +111,7 @@ def parse_parser(parser, data=None, **kwargs):
             # Quote default values for string/None types
             default = action.default
             if action.default not in ['', None, True, False] and action.type in [None, str] and isinstance(action.default, str):
-                default = f'"{default}"'
+                default = f"'{default}'"
 
             # fill in any formatters, like %(default)s
             format_dict = dict(vars(action), prog=data.get('prog', ''), default=default)

test/roots/test-default-html/special-characters.rst

@@ -0,0 +1,6 @@
+Special Characters
+==================
+
+.. argparse::
+   :filename: test/sample-directive-special.py
+   :func: get_parser

test/sample-directive-special.py

@@ -0,0 +1,28 @@
+import argparse
+
+
+def get_parser():
+    parser = argparse.ArgumentParser(
+        prog='sample-directive-special',
+        description='Support SphinxArgParse HTML testing (with defaults)',
+    )
+
+    parser.add_argument(
+        '--some-int',
+        help='Regular scalar input with default value',
+        default=420,
+        type=int,
+    )
+    parser.add_argument(
+        '--some-text',
+        help='Scalar text input',
+        default="*.rst _txt_ **strong** *italic* ``code``",
+    )
+    parser.add_argument(
+        '--list-text',
+        help='List input for some bits of text',
+        default=["*.rst", "_txt_", "**strong**", "*italic*", "``code``"],
+        nargs="+",
+    )
+
+    return parser

test/test_default_html.py

@@ -29,6 +29,14 @@
                 (".//section[@id='positional-arguments']", ''),
                 (".//section[@id='positional-arguments']/dl/dt[1]/kbd", 'baz'),
             ],
+            'special-characters.html': [
+                (".//h1", 'Sample', False),
+                (".//h1", 'Special Characters'),
+                (".//section/dl/dd/p", 'Default:'),
+                (".//section/dl/dd/p/code/span", '420'),
+                (".//section/dl/dd/p/code/span", "'*.rst"),
+                (".//section/dl/dd/p/code/span", r"\['\*.rst',"),
+            ],
         }
     ),
 )