sphinx-argparse-cli 1.21.1__tar.gz → 1.21.3__tar.gz

{sphinx_argparse_cli-1.21.1 → sphinx_argparse_cli-1.21.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-argparse-cli
-Version: 1.21.1
+Version: 1.21.3
 Summary: render CLI arguments (sub-commands friendly) defined by argparse module
 Project-URL: Documentation, https://github.com/tox-dev/sphinx-argparse-cli#sphinx-argparse-cli
 Project-URL: Homepage, https://github.com/tox-dev/sphinx-argparse-cli

{sphinx_argparse_cli-1.21.1 → sphinx_argparse_cli-1.21.3}/src/sphinx_argparse_cli/__init__.py

@@ -15,10 +15,24 @@ def setup(app: Sphinx) -> dict[str, Any]:
 
     app.add_directive(SphinxArgparseCli.name, SphinxArgparseCli)
     app.add_config_value("sphinx_argparse_cli_prefix_document", False, "env")  # noqa: FBT003
+    app.add_css_file("sphinx_argparse_cli.css")
+    app.connect("build-finished", _write_css)
 
     return {"parallel_read_safe": True}
 
 
+def _write_css(app: Sphinx, exception: Exception | None) -> None:
+    if exception or not app.builder or app.builder.format != "html":
+        return
+    from pathlib import Path  # noqa: PLC0415
+
+    static = Path(app.outdir) / "_static"
+    static.mkdir(parents=True, exist_ok=True)
+    (static / "sphinx_argparse_cli.css").write_text(
+        ".sphinx-argparse-cli-wrap pre { white-space: pre-wrap; word-wrap: break-word; }\n"
+    )
+
+
 __all__ = [
     "__version__",
 ]

{sphinx_argparse_cli-1.21.1 → sphinx_argparse_cli-1.21.3}/src/sphinx_argparse_cli/_logic.py

@@ -25,6 +25,7 @@ from docutils.nodes import (
     Node,
     Text,
     bullet_list,
+    container,
     fully_normalize_name,
     list_item,
     literal,
@@ -144,7 +145,8 @@ class SphinxArgparseCli(SphinxDirective):
                 self._parser.prog = new_prog
                 _update_sub_parser_prog(self._parser, old_prog, new_prog)
 
-            self._raw_format = self._parser.formatter_class == RawDescriptionHelpFormatter
+            formatter = self._parser.formatter_class
+            self._raw_format = isinstance(formatter, type) and issubclass(formatter, RawDescriptionHelpFormatter)
         return self._parser
 
     def _load_sub_parsers(
@@ -187,7 +189,7 @@ class SphinxArgparseCli(SphinxDirective):
         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])
 
@@ -223,7 +225,7 @@ class SphinxArgparseCli(SphinxDirective):
         if block is None:
             return None
         if self._raw_format and "\n" in block:
-            lit = literal_block("", Text(block))
+            lit = literal_block("", Text(block), classes=["sphinx-argparse-cli-wrap"])
             lit["language"] = "none"
             return lit
         return paragraph("", Text(block))
@@ -423,7 +425,7 @@ class SphinxArgparseCli(SphinxDirective):
         with self.no_color():
             texts = parser.format_usage()[len("usage: ") :].splitlines()
         texts = [line if at == 0 else f"{' ' * (len(parser.prog) + 1)}{line.lstrip()}" for at, line in enumerate(texts)]
-        return literal_block("", Text("\n".join(texts)))
+        return literal_block("", Text("\n".join(texts)), classes=["sphinx-argparse-cli-wrap"])
 
     @contextmanager
     def no_color(self) -> Iterator[None]:

{sphinx_argparse_cli-1.21.1 → sphinx_argparse_cli-1.21.3}/src/sphinx_argparse_cli/version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.21.1'
-__version_tuple__ = version_tuple = (1, 21, 1)
+__version__ = version = '1.21.3'
+__version_tuple__ = version_tuple = (1, 21, 3)
 
 __commit_id__ = commit_id = None

{sphinx_argparse_cli-1.21.1 → sphinx_argparse_cli-1.21.3}/tests/test_logic.py

@@ -133,6 +133,15 @@ def test_multiline_epilog_as_html(build_outcome: str) -> None:
     assert ref in build_outcome
 
 
+@pytest.mark.sphinx(buildername="html", testroot="epilog-multiline-subclass")
+def test_multiline_epilog_subclass_formatter_as_html(build_outcome: str) -> None:
+    ref = (
+        "This epilog\nspans multiple lines.\n\n  this line is indented.\n    and also this.\n\nNow this should be"
+        " a separate paragraph.\n"
+    )
+    assert ref in build_outcome
+
+
 @pytest.mark.sphinx(buildername="text", testroot="complex")
 @pytest.mark.prepare(directive_args=[":usage_width: 100"])
 def test_usage_width_default(build_outcome: str) -> None:
@@ -407,6 +416,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