🐛 fix(toctree): crash with empty title in toctree (#296)

Author: gaborbernat

roots/test-title-empty-groups/cli.rst

@@ -0,0 +1,7 @@
+CLI
+===
+
+.. sphinx_argparse_cli::
+  :module: parser
+  :func: make
+  :title:

roots/test-title-empty-groups/index.rst

@@ -1,4 +1,10 @@
-.. sphinx_argparse_cli::
-  :module: parser
-  :func: make
-  :title:
+Overview
+========
+
+.. toctree::
+   :hidden:
+
+   self
+   cli
+
+See :doc:`cli` for details.

src/sphinx_argparse_cli/_logic.py

@@ -25,6 +25,7 @@
     Node,
     Text,
     bullet_list,
+    container,
     fully_normalize_name,
     list_item,
     literal,
@@ -187,7 +188,7 @@ def run(self) -> list[Node]:
         self.env.note_reread()  # this document needs to be always updated
         title_text = self.options.get("title", f"{self.parser.prog} - CLI interface").strip()
         if not title_text:
-            home_section: Element = section("")
+            home_section: Element = container("")
         else:
             home_section = section("", title("", Text(title_text)), ids=[self.make_id(title_text)], names=[title_text])
 

tests/test_logic.py

@@ -407,6 +407,10 @@ def test_multiword_prog(build_outcome: str) -> None:
 
 
 @pytest.mark.sphinx(buildername="html", testroot="title-empty-groups")
-def test_empty_title_groups_in_toctree(build_outcome: str) -> None:
-    assert '<section id="tool-options">' in build_outcome
-    assert "be verbose" in build_outcome
+def test_empty_title_groups_in_toctree(app: SphinxTestApp, monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setenv("FORCE_COLOR", "1")
+    monkeypatch.delenv("NO_COLOR", raising=False)
+    app.build()
+    cli_html = (Path(app.outdir) / "cli.html").read_text()
+    assert '<section id="tool-options">' in cli_html
+    assert "be verbose" in cli_html