Metadata-Version: 2.5
Name: sphinx_jinja2
Version: 0.1.0
Summary: A sphinx extension to render jinja templates, using minijinja.
Keywords: sphinx,extension,jinja,minijinja
Author-email: Chris Sewell <chrisj_sewell@hotmail.com>
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-Expression: MIT
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Typing :: Typed
License-File: LICENSE
Requires-Dist: sphinx>=7.2
Requires-Dist: minijinja>=2.15
Requires-Dist: furo ; extra == "docs"
Requires-Dist: pytest ; extra == "testing"
Requires-Dist: syrupy>=5 ; extra == "testing"
Requires-Dist: pytest-cov ; extra == "testing"
Requires-Dist: coverage[toml] ; extra == "testing"
Requires-Dist: myst-parser ; extra == "testing"
Project-URL: Documentation, https://sphinx-jinja2.readthedocs.io/
Project-URL: Homepage, https://github.com/sphinx-extensions2/sphinx-jinja2
Provides-Extra: docs
Provides-Extra: testing
Import-Name: sphinx_jinja2

# sphinx-jinja2

[![PyPI][pypi-badge]][pypi-link]

> A sphinx extension to add the `jinja` directive, for rendering Jinja templates (powered by [minijinja](https://github.com/mitsuhiko/minijinja)).

**Note:** This is an adaption of [https://github.com/tardyp/sphinx-jinja](https://github.com/tardyp/sphinx-jinja), which appears to be unmaintained.

**See also: sphinx-ub-directives.** The `ub-template` directive in
[sphinx-ub-directives](https://pypi.org/project/sphinx-ub-directives/) renders minijinja templates with the same
`:file:`, `:ctx:`, `:debug:` and `:raw:` options; with its configuration in `ubproject.toml`, the same project also renders in ubCode.
It is stricter by design: contexts are data only (no `env`, Python objects or functions),
there are no custom filters, tests or environment options, and template output may not contain headings.
The two extensions can be used side by side. sphinx-jinja2 remains maintained with bug fixes and compatibility updates,
while new template features are developed in sphinx-ub-directives, which is developed alongside sphinx-needs and also works in ubCode;
to switch, see [Migrating from sphinx-jinja2](https://sphinx-ub-directives.readthedocs.io/en/latest/migrating.html).

See [the documentation](https://sphinx-jinja2.readthedocs.io) for more information.

[pypi-badge]: https://img.shields.io/pypi/v/sphinx-jinja2.svg
[pypi-link]: https://pypi.org/project/sphinx-jinja2

