Fix handling of argparse.SUPPRESS (#149)

* Fix handling of argparse.SUPPRESS

* Add test for argparse.SUPPRESS

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: mayrholu

roots/test-suppressed-action/conf.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).parent))
+extensions = ["sphinx_argparse_cli"]
+nitpicky = True

roots/test-suppressed-action/index.rst

@@ -0,0 +1,3 @@
+.. sphinx_argparse_cli::
+  :module: parser
+  :func: make

roots/test-suppressed-action/parser.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from argparse import SUPPRESS, ArgumentParser
+
+
+def make() -> ArgumentParser:
+    parser = ArgumentParser(prog="foo", description="desc", add_help=False)
+    parser.add_argument(
+        "--activities-since",
+        metavar="TIMESTAMP",
+        help=SUPPRESS,
+    )
+    return parser

src/sphinx_argparse_cli/_logic.py

@@ -181,6 +181,8 @@ def _mk_option_group(self, group: _ArgumentGroup, prefix: str) -> section:
         self._register_ref(ref_id, title_text, group_section)
         opt_group = bullet_list()
         for action in group._group_actions:  # noqa: SLF001
+            if action.help == SUPPRESS:
+                continue
             point = self._mk_option_line(action, prefix)
             opt_group += point
         group_section += opt_group

tests/test_logic.py

@@ -120,6 +120,11 @@ def test_usage_width_custom(build_outcome: str) -> None:
     assert "complex second [-h] [--flag] [--root]\n" in build_outcome
 
 
+@pytest.mark.sphinx(buildername="text", testroot="suppressed-action")
+def test_suppressed_action(build_outcome: str) -> None:
+    assert "--activities-since" not in build_outcome
+
+
 @pytest.mark.parametrize(
     ("example", "output"),
     [