Skip to main content

includes jinja templates in a documentation

Project description

.. image::


A sphinx extension to include jinja based templates based documentation into a sphinx doc


In your rst doc, you can use the following snippet to use a jinja template to generate your doc

.. code:: rst

.. jinja:: first_ctx

{% for k, v in topics.items() %}

{% endfor %}

In your sphinx ```` file, you can create or load the contexts needed for your jinja templates

extensions = ['sphinxcontrib.jinja']

jinja_contexts = {
'first_ctx': {'topics': {'a': 'b', 'c': 'd'}}

Available options

- ``file``: allow to specify a path to Jinja instead of writing it into the content of the
directive. Path is relative to the current directory of sphinx-build tool, typically the directory
where the ```` file is located.
- ``header_char``: character to use for the the headers. You can use it in your template to set your
own title character::

For example:

{{ options.header_char * 5 }}

Example of declaration in your RST file:

.. code:: rst

.. jinja:: approval_checks_api
:file: relative/path/to/template.jinja
:header_char: -

Each element of the `jinja_contexts` dictionary is a context dict for use in your jinja templates.

Running tests

* pip install tox
* tox

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinx-jinja, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_jinja-0.2.0-py2-none-any.whl (4.9 kB) File type Wheel Python version 2.7 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page