Extend pre-wrapped text support to options

Seems click will let you use the '\b' character in help text for options also. Signed-off-by: Stephen Finucane <[email protected]> Closes: #106
click-contrib · Jun 20, 2022 · fdea9dd · fdea9dd
1 parent 011a998
commit fdea9dd
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/sphinx_click/ext.py b/sphinx_click/ext.py
@@ -150,9 +150,16 @@ def _format_option(opt: click.Option) -> ty.Generator[str, None, None]:
     yield '.. option:: {}'.format(opt_help[0])
     if opt_help[1]:
         yield ''
+        bar_enabled = False
         for line in statemachine.string2lines(
             ANSI_ESC_SEQ_RE.sub('', opt_help[1]), tab_width=4, convert_whitespace=True
         ):
+            if line == '\b':
+                bar_enabled = True
+                continue
+            if line == '':
+                bar_enabled = False
+            line = '| ' + line if bar_enabled else line
             yield _indent(line)
 
 

diff --git a/tests/test_formatter.py b/tests/test_formatter.py
@@ -424,6 +424,19 @@ def test_no_line_wrapping(self):
 that will be rewrapped again.
 """
         )
+        @click.option(
+            '--param',
+            help="""An option containing pre-wrapped text.
+
+            \b
+            This is
+            a paragraph
+            without rewrapping.
+
+            And this is a paragraph
+            that will be rewrapped again.
+            """,
+        )
         def cli():
             """A command containing pre-wrapped text.
 
@@ -457,6 +470,19 @@ def cli():
 
             cli [OPTIONS]
 
+        .. rubric:: Options
+
+        .. option:: --param <param>
+
+            An option containing pre-wrapped text.
+
+            | This is
+            | a paragraph
+            | without rewrapping.
+
+            And this is a paragraph
+            that will be rewrapped again.
+
         An epilog containing pre-wrapped text.
 
         | This is