Skip to content

Document workaround fror #3 #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,38 @@ 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}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```{rst-eval}
```{eval-rst}

.. jinja::
:ctx: {"foo":"bar"}

Baz.
```

rather than using it directly:

.. code-block:: markdown

```{jinja}
:ctx: {"foo":"bar"}

Baz.
```




Configuration
-------------

Expand Down