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
File details
Details for the file sphinx-jinja-1.0.0.tar.gz.
File metadata
- Download URL: sphinx-jinja-1.0.0.tar.gz
- Upload date:
- Size: 7.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.7.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 768061fe1f07f29517c7ebb212422852760c355640b290fd4460bffdcb4310d5 |
|
| MD5 | 7d03bea1b1ea563ce2660c8026c9b153 |
|
| BLAKE2b-256 | 17e843c58fb4e49afca3f8f4a5ac7ac0070c5a941949314466d9a56c729a54fb |
Provenance
File details
Details for the file sphinx_jinja-1.0.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_jinja-1.0.0-py3-none-any.whl
- Upload date:
- Size: 3.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.7.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f90e754ceb12e5837cb7f7ade189b98e6bb18f308e8a6494eaff0f6589d20d87 |
|
| MD5 | d7fe0da2612c4ff8f537bd99e3cfa3e3 |
|
| BLAKE2b-256 | 500d4773e81743900ba939a672ed47aa23505e8da755007548521ce6a297bb55 |
