在文档中包含jinja模板

sphinx-jinja的Python项目详细描述


https://img.shields.io/travis/tardyp/sphinx-jinja.svg?maxAge=2592000

狮身人面像

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
  • 毒性

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
加密如何在Java中使用Skipjack(skip32)将数据库中的顺序整数随机化   java Android在两个活动之间传递数据获取NullPointerException   在构造函数中传递的java上下文显示错误   java将密钥添加到选定的密钥集   javascript为什么带有特殊字符的字符串在GET和POST方法中的行为不同?   java将反射。方法创建一个函数接口   设置Javasocket的端口   java通过一次按键调用MenuItem   java和引擎加载图形:为什么我的背景纹理很小,而且是颠倒的   如何将UV纹理从blender加载到opengl 安卓 java   跨Java虚拟机实现的jvm Java toString表示?   spring在Java服务器页面的上下文中这叫什么?