Special formatting of ranges as choices instead of listing entries

Author: jonrebm

sphinxarg/ext.py

@@ -87,6 +87,12 @@ def render_list(l, markdown_help, settings=None):
         return all_children
 
 
+def format_choices(choices):
+    if isinstance(choices, range) and choices.step == 1:
+        return f'Value range: {choices.start} to {choices.stop}\n'
+    return f'Possible choices: {", ".join(str(c) for c in choices)}\n'
+
+
 def _is_suppressed(item: str | None) -> bool:
     """Return whether item should not be printed."""
     if item is None:
@@ -157,9 +163,7 @@ def print_action_groups(
                 # Build the help text
                 arg = []
                 if 'choices' in entry:
-                    arg.append(
-                        f"Possible choices: {', '.join(str(c) for c in entry['choices'])}\n"
-                    )
+                    arg.append(format_choices(entry['choices']))
                 if 'help' in entry:
                     arg.append(entry['help'])
                 if not _is_suppressed(entry['default']):
@@ -400,9 +404,7 @@ def _format_positional_arguments(self, parser_info):
             elif 'choices' not in arg:
                 arg_items.append(nodes.paragraph(text='Undocumented'))
             if 'choices' in arg:
-                arg_items.append(
-                    nodes.paragraph(text='Possible choices: ' + ', '.join(arg['choices']))
-                )
+                arg_items.append(format_choices(arg['choices']))
             items.append(
                 nodes.option_list_item(
                     '',
@@ -432,9 +434,7 @@ def _format_optional_arguments(self, parser_info):
             elif 'choices' not in opt:
                 opt_items.append(nodes.paragraph(text='Undocumented'))
             if 'choices' in opt:
-                opt_items.append(
-                    nodes.paragraph(text='Possible choices: ' + ', '.join(opt['choices']))
-                )
+                arg_items.append(format_choices(opt['choices']))
             items.append(
                 nodes.option_list_item(
                     '',