sphinx-jinja 1.1.0

狮身人面像

sphinx扩展，将基于jinja的模板的文档包含到sphinx文档中

用法

在RST文档中，可以使用以下代码片段使用Jinja模板生成文档

..jinja:: first_ctx

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

    {{k}}
    ~~~~~
    {{v}}
    {% endfor %}

在sphinx conf.py文件中，可以创建或加载jinja模板所需的上下文

extensions=['sphinxcontrib.jinja']jinja_contexts={'first_ctx':{'topics':{'a':'b','c':'d'}}}

可用选项

• file：允许指定jinja的路径，而不是将其写入 指令。路径相对于sphinx构建工具的当前目录，通常是 conf.py文件所在的位置。

• header_char：用于标题的字符。您可以在模板中使用它来设置

  自己的标题字符：

  例如：

  Title
  {{ options.header_char * 5 }}
  

RST文件中的声明示例：

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

jinja上下文词典的每个元素都是一个上下文dict，可在jinja模板中使用。

运行测试

• pip安装tox
• 毒性