includes jinja templates in a documentation
Project description
sphinx-jinja
A sphinx extension to include jinja based templates based documentation into a sphinx doc
Usage
In your rst doc, you can use the following snippet to use a jinja template to generate your doc
.. jinja:: first_ctx
{% for k, v in topics.items() %}
{{k}}
~~~~~
{{v}}
{% endfor %}In your sphinx conf.py 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 conf.py 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:
Title {{ options.header_char * 5 }}
Example of declaration in your RST file:
.. 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_jinja-1.1.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 359b97513f93878defb121df009ad2e33fd45f368fe4792ccd21d76ed8e1b64d |
|
| MD5 | 1468cb799ecebe19420a7465ed07ddb4 |
|
| BLAKE2b-256 | 586e9e1856130db948e5d485ec4ac564e0551942f5395d1c1bb96d7b2370d9e0 |
