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-0.2.1-py2-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7d837a156965e5886b44b1fef3e1b9a28a337dcba0660cd4f5af16f4a67cb292 |
|
| MD5 | aecbf36549bb4e582a2eb4b1894ecd6d |
|
| BLAKE2b-256 | c428ab20614047a323e68ba69dc030c02f6adb55fa035fb2fe12b7b63aa7ccd7 |
