Allow to add content to directive (#158)

* Allow to add content to directive

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

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

* Minor change

---------

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

Author: mondeja

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## Unreleased
+
+- Allow to add content to directive.
+
 ## 1.13.1
 
 - Fix multiline handling of group descriptions.

roots/test-nested/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-nested/index.rst

@@ -0,0 +1,13 @@
+.. sphinx_argparse_cli::
+  :module: parser
+  :func: make_1
+
+  Some text inside first directive.
+
+  .. sphinx_argparse_cli::
+    :module: parser
+    :func: make_2
+
+    Some text inside second directive.
+
+Some text after directives.

roots/test-nested/parser.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from argparse import ArgumentParser
+
+
+def make_1() -> ArgumentParser:
+    return ArgumentParser(prog="basic-1")
+
+
+def make_2() -> ArgumentParser:
+    return ArgumentParser(prog="basic-2")

src/sphinx_argparse_cli/_logic.py

@@ -57,7 +57,7 @@ def make_id(key: str) -> str:
 
 class SphinxArgparseCli(SphinxDirective):
     name = "sphinx_argparse_cli"
-    has_content = False
+    has_content = True
     option_spec: ClassVar[dict[str, Any]] = {
         "module": unchanged_required,
         "func": unchanged_required,
@@ -173,6 +173,9 @@ def run(self) -> list[Node]:
         if epilog := self._pre_format(self.options.get("epilog", self.parser.epilog)):
             home_section += epilog
 
+        if self.content:
+            self.state.nested_parse(self.content, self.content_offset, home_section)
+
         return [home_section]
 
     def _pre_format(self, block: None | str) -> None | paragraph | literal_block:

tests/test_logic.py

@@ -297,3 +297,16 @@ def test_with_default(build_outcome: str) -> None:
 * **"x"** - arg (default: True)
 """
     )
+
+
+@pytest.mark.sphinx(buildername="html", testroot="nested")
+def test_nested_content(build_outcome: str) -> None:
+    assert '<section id="basic-1---CLI-interface">' in build_outcome
+    assert "<h1>basic-1 - CLI interface" in build_outcome
+    assert "<h2>basic-1 opt" in build_outcome
+    assert "<p>Some text inside first directive.</p>" in build_outcome
+    assert '<section id="basic-2---CLI-interface">' in build_outcome
+    assert "<h2>basic-2 - CLI interface" in build_outcome
+    assert "<h3>basic-2 opt" in build_outcome
+    assert "<p>Some text inside second directive.</p>" in build_outcome
+    assert "<p>Some text after directives.</p>" in build_outcome