Keep --help as part of options raw output (#29)

mkdocs_click/_docs.py

@@ -104,11 +104,15 @@ def _make_options(ctx: click.Context) -> Iterator[str]:
     """Create the Markdown lines describing the options for the command."""
     formatter = ctx.make_formatter()
     click.Command.format_options(ctx.command, ctx, formatter)
+
+    option_lines = formatter.getvalue().splitlines()
+
     # First line is redundant "Options"
-    # Last line is `--help`
-    option_lines = formatter.getvalue().splitlines()[1:-1]
-    if not option_lines:
-        return
+    option_lines = option_lines[1:]
+
+    if not option_lines:  # pragma: no cover
+        # We expect at least `--help` to be present.
+        raise RuntimeError("Expected at least one option")
 
     yield "Options:"
     yield ""

tests/app/expected.md

@@ -8,6 +8,12 @@ Usage:
 cli [OPTIONS] COMMAND [ARGS]...
 ```
 
+Options:
+
+```
+  --help  Show this message and exit.
+```
+
 ## bar
 
 The bar command
@@ -18,6 +24,12 @@ Usage:
 cli bar [OPTIONS] COMMAND [ARGS]...
 ```
 
+Options:
+
+```
+  --help  Show this message and exit.
+```
+
 ### hello
 
 Simple program that greets NAME for a total of COUNT times.
@@ -33,6 +45,7 @@ Options:
 ```
   --count INTEGER  Number of greetings.
   --name TEXT      The person to greet.
+  --help           Show this message and exit.
 ```
 
 ## foo
@@ -42,3 +55,9 @@ Usage:
 ```
 cli foo [OPTIONS]
 ```
+
+Options:
+
+```
+  --help  Show this message and exit.
+```

tests/unit/test_docs.py

@@ -32,6 +32,7 @@ def hello():
 
     ```
       -d, --debug TEXT  Include debug output
+      --help            Show this message and exit.
     ```
 
     """
@@ -80,6 +81,12 @@ def test_custom_multicommand():
         multi [OPTIONS] COMMAND [ARGS]...
         ```
 
+        Options:
+
+        ```
+          --help  Show this message and exit.
+        ```
+
         ## hello
 
         Hello, world!
@@ -94,6 +101,7 @@ def test_custom_multicommand():
 
         ```
           -d, --debug TEXT  Include debug output
+          --help            Show this message and exit.
         ```
         """
     ).lstrip()