Merge pull request #7 from i-VRESSE/no-subcommands

Support parser without sub-commands

Author: sverhoeven

CONTRIBUTING.md

@@ -46,7 +46,7 @@ In case you feel like you've made a valuable contribution, but you don't know ho
 To create a release you need write permission on the repository.
 
 1. Check the author list in [`CITATION.cff`](CITATION.cff)
-2. Bump the version in `mkdocs_rich_argparse/__init__.py, pyproject.toml`.
+2. Bump the version in `mkdocs_rich_argparse/__init__.py`.
 3. Go to the [GitHub release page](https://github.com/i-VRESSE/mkdocs_rich_argparse/releases)
 4. Press draft a new release button
 5. Fill version, title and description field

README.dev.md

@@ -51,6 +51,8 @@ coverage report
 
 `coverage` can also generate output in HTML and other formats; see `coverage help` for more information.## Running linters locally
 
+## Linting and formatting
+
 For linting and sorting imports we will use [ruff](https://docs.astral.sh/ruff/). Running the linters requires [uv](https://docs.astral.sh/uv) installed.
 
 ```shell
@@ -61,6 +63,8 @@ uvx ruff check .
 uvx ruff check . --fix
 ```
 
-### (3/3) GitHub
+For formatting we also use ruff
 
-Don't forget to also make a [release on GitHub](https://github.com/i-VRESSE/mkdocs_rich_argparse/releases/new).
+```shell
+uvx ruff format .
+```

src/mkdocs_rich_argparse/__init__.py

@@ -17,7 +17,7 @@
 from rich.text import Text
 from rich_argparse import RichHelpFormatter
 
-__version__ = "0.1.2"
+__version__ = "0.1.3"
 
 logger = mkdocs.plugins.get_plugin_logger(__name__)
 
@@ -56,6 +56,11 @@ def argparser_to_markdown(parser: argparse.ArgumentParser, heading: str = "CLI R
     ]
 
     subparsers_actions = [action for action in parser._actions if isinstance(action, argparse._SubParsersAction)]
+
+    # Only process subcommands if they exist
+    if not subparsers_actions:
+        return "\n".join(lines)
+
     current_subparsers_action = subparsers_actions[0]
 
     for sub_cmd_name, sub_cmd_parser in current_subparsers_action.choices.items():

tests/test_plugin.py

@@ -93,3 +93,38 @@ def test_argparser_to_markdown_with_color(monkeypatch: pytest.MonkeyPatch, sampl
 
     assert len(result) > 3500
     assert '<span style="color: #008080; text-decoration-color: #008080">' in result
+
+
+@pytest.fixture
+def sample_parser_without_subcommands():
+    parser = argparse.ArgumentParser(
+        prog="myprogram", description="This is my program.", formatter_class=RichHelpFormatter
+    )
+    parser.add_argument("--verbose", action="store_true", help="Enable verbose mode")
+    return parser
+
+
+def test_argparser_to_markdown_without_subcommands(sample_parser_without_subcommands: argparse.ArgumentParser):
+    result = argparser_to_markdown(sample_parser_without_subcommands, heading="My Program CLI")
+
+    expected = dedent("""\
+        # My Program CLI
+        Documentation for the `myprogram` script.
+        ```console
+        myprogram --help
+        ```
+        <pre style="font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace">
+        <code style="font-family:inherit" class="nohighlight">
+        Usage: myprogram [-h] [--verbose]
+
+        This is my program.
+
+        Options:
+          -h, --help  show this help message and exit
+          --verbose   Enable verbose mode
+
+        </code>
+        </pre>
+    """)
+
+    assert result == expected