Support 'metavar'

We need to be careful here to strip out potential option markers. Signed-off-by: Stephen Finucane <[email protected]> Closes: #6
click-contrib · Jul 23, 2020 · 382d7e5 · 382d7e5
1 parent b511f56
commit 382d7e5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/sphinx_click/ext.py b/sphinx_click/ext.py
@@ -44,7 +44,10 @@ def _get_help_record(opt):
     def _write_opts(opts):
         rv, _ = click.formatting.join_options(opts)
         if not opt.is_flag and not opt.count:
-            rv += ' <{}>'.format(opt.name)
+            name = opt.name
+            if opt.metavar:
+                name = opt.metavar.lstrip('<[{($').rstrip('>]})$')
+            rv += ' <{}>'.format(name)
         return rv
 
     rv = [_write_opts(opt.opts)]

diff --git a/tests/test_formatter.py b/tests/test_formatter.py
@@ -46,6 +46,7 @@ def test_basic_parameters(self):
 
         @click.command()
         @click.option('--param', envvar='PARAM', help='A sample option')
+        @click.option('--another', metavar='[FOO]', help='Another option')
         @click.option(
             '--choice',
             help='A sample option with choices',
@@ -75,6 +76,10 @@ def foobar(bar):
 
             A sample option
 
+        .. option:: --another <FOO>
+
+            Another option
+
         .. option:: --choice <choice>
 
             A sample option with choices