From 5f8e3aadac30f92812458cbe41b6fe9884bbd576 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?V=C3=A1clav=20=C5=A0milauer?= <eu@doxos.eu>
Date: Thu, 26 Sep 2024 22:55:11 +0200
Subject: [PATCH 1/3] Implement and document the raw option

---
 docs/index.rst                | 16 ++++++++++++++++
 src/sphinx_jinja2/__init__.py | 18 ++++++++++++------
 2 files changed, 28 insertions(+), 6 deletions(-)

diff --git a/docs/index.rst b/docs/index.rst
index 437b5db..392696a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -129,6 +129,22 @@ To see the rendered templates in the built documentation, use the ``debug`` opti
 
         Hallo **{{ name }}**!
 
+
+
+Raw output
+**********
+
+The role can be used to produce raw ouput instead of interpreted RST:
+
+.. jinja2-example::
+
+      .. jinja::
+          :ctx: {"name": "World"}
+          :raw: html
+
+          Hello <em>{{ name }}</em>
+
+
 Warning messages
 ****************
 
diff --git a/src/sphinx_jinja2/__init__.py b/src/sphinx_jinja2/__init__.py
index 1e5c7fb..f0cc716 100644
--- a/src/sphinx_jinja2/__init__.py
+++ b/src/sphinx_jinja2/__init__.py
@@ -97,6 +97,7 @@ class JinjaDirective(SphinxDirective):
         "file": directives.path,
         "ctx": directives.unchanged,
         "debug": directives.flag,
+        "raw": directives.unchanged,
     }
     options: JinjaOptions
     arguments: list[str]
@@ -187,12 +188,17 @@ def _warn(msg: str) -> None:
             _warn(f"Error rendering jinja template: {exc.__class__.__name__}: {exc}")
             return []
 
-        # insert the new content into the source stream
-        # setting the source and line number
-        new_lines = StringList(
-            new_content.splitlines(), items=[(source, line - 1) for _ in new_content.splitlines()]
-        )
-        self.state_machine.insert_input(new_lines, source)
+        if not 'raw' in self.options:
+            # insert the new content into the source stream
+            # setting the source and line number
+            new_lines = StringList(
+                new_content.splitlines(), items=[(source, line - 1) for _ in new_content.splitlines()]
+            )
+            self.state_machine.insert_input(new_lines, source)
+        else:
+            raw_node = nodes.raw('', new_content, classes='jinja-rendered', format=self.options['raw'])
+            (raw_node.source, raw_node.line) = self.state_machine.get_source_and_line(self.lineno)
+            return [raw_node]
 
         if conf.debug or "debug" in self.options:
             # return the rendered template

From 0a2997b171ff774bfe92407b85b8ad5d982070fd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?V=C3=A1clav=20=C5=A0milauer?= <eu@doxos.eu>
Date: Thu, 26 Sep 2024 22:57:08 +0200
Subject: [PATCH 2/3] Document workaround for #3

---
 docs/index.rst | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/docs/index.rst b/docs/index.rst
index 392696a..dac4a37 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -157,6 +157,37 @@ Warning messages are displayed in the Sphinx build output, for problematic input
 Since is difficult / impossible to map the source line numbers, from the template to the Jinja rendered content,
 problems with the parsing of the rendered content always refer to the first line number either of the ``jinja`` directive, or the template file (when using the ``file`` option).
 
+
+Known issues
+-------------
+
+* [#3](https://github.com/sphinx-extensions2/sphinx-jinja2/issues/3): template output is fed back into the RST parser. When the source uses `MyST parser <https://myst-parser.readthedocs.io/en/latest/index.html>`__, this will trigger an error::
+
+       Directive 'jinja' cannot be mocked: MockingError: MockStateMachine has not yet implemented 'insert_input'.
+
+
+   The workaround is to wrap the `jinja` directive inside `rst-eval`
+
+   .. code-block:: rst
+
+      ```{rst-eval}
+      .. jinja::
+         :ctx: {"foo":"bar"}
+
+         Baz.
+      ```
+
+   rather than using it directly:
+
+   .. code-block:: markdown
+
+      ```{jinja}
+      :ctx: {"foo":"bar"}
+
+      Baz.
+      ```
+
+
 Configuration
 -------------
 

From d5cc99bcc17f681decfdcefd41d875ffe458f967 Mon Sep 17 00:00:00 2001
From: "pre-commit-ci[bot]"
 <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date: Thu, 26 Sep 2024 20:58:38 +0000
Subject: [PATCH 3/3] [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci
---
 src/sphinx_jinja2/__init__.py | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/src/sphinx_jinja2/__init__.py b/src/sphinx_jinja2/__init__.py
index f0cc716..68bcd1f 100644
--- a/src/sphinx_jinja2/__init__.py
+++ b/src/sphinx_jinja2/__init__.py
@@ -188,15 +188,18 @@ def _warn(msg: str) -> None:
             _warn(f"Error rendering jinja template: {exc.__class__.__name__}: {exc}")
             return []
 
-        if not 'raw' in self.options:
+        if "raw" not in self.options:
             # insert the new content into the source stream
             # setting the source and line number
             new_lines = StringList(
-                new_content.splitlines(), items=[(source, line - 1) for _ in new_content.splitlines()]
+                new_content.splitlines(),
+                items=[(source, line - 1) for _ in new_content.splitlines()],
             )
             self.state_machine.insert_input(new_lines, source)
         else:
-            raw_node = nodes.raw('', new_content, classes='jinja-rendered', format=self.options['raw'])
+            raw_node = nodes.raw(
+                "", new_content, classes="jinja-rendered", format=self.options["raw"]
+            )
             (raw_node.source, raw_node.line) = self.state_machine.get_source_and_line(self.lineno)
             return [raw_node]