放置自定义 nbconvert 模板的正确位置

Question

我制作了一个自定义 nbconvert 模板，并希望可以从我启动 nbconvert 实用程序的任何文件夹访问它。我应该把我的模板放在哪里？

我在官方文档中找不到任何内容。我已经尝试了 jupyter 配置的常用位置，例如 /usr/share/jupyter、~/.local/share/jupyter、~/.jupyter，但无济于事。

到目前为止我找到的唯一地方是 python 包所在的文件夹：

$ pip show nbconvert | grep Location | cut -d" " -f2
/usr/lib/python3.6/site-packages

如果我在那里创建 nbconvert/templates/html 目录并将我的模板放入其中，nbconvert --to html --template <my_template_name> ... 工作正常。但这是一个丑陋的 hack，每次更新 nbconvert 时我都需要重新做。

似乎我可以为 nbconvert 提供环境变量，但我更愿意避免使用此选项。

Answer 1

您需要通过创建 jupyter_nbconvert_config.py 文件并将其存储在 ~/.jupyter.

中来告诉 nbconvert 查找您的模板

我将其用于 LaTeX——我的文件如下所示：

import os
c = get_config()

c.LatexExporter.template_path = ['.', os.path.expanduser('~/.jupyter/templates')]
c.LatexExporter.template_file = 'custom_latex.tplx'

假设您的模板扩展了现有模板，您需要在设置 template_path 时包含 '.'，以便它知道在哪里寻找标准模板。

Answer 2

来自docs.

保存自定义模板的推荐位置是您的 jupyter 数据目录：

share/jupyter
- nbconvert
  - 模板
    - html
    - 乳胶

交替

from jupyter_core.paths import jupyter_path
print(jupyter_path('nbconvert','templates'))

Answer 3

除了编辑 jupyter_nbconvert_config.py，您还可以编辑 jupyter_nbconvert_config.json。首先断言 ~/.jupyter 在带有 jupyter --path 的配置路径中。然后在jupyter_nbconvert_config.json 中插入一个模板目录。我添加了一个子文件夹 custome_templates 到我的：

{
  "Exporter": {
    "template_path": [
      ".", 
      "/home/moutsopoulosg/miniconda/envs/myenv/lib/python2.7/site-packages/jupyter_contrib_nbextensions/templates",
      "/home/moutsopoulosg/.jupyter/custom_templates"
    ], 
    ...
  },
  "version": 1
}

然后 nbconvert --template mytemplate Untitiled.ipynb 选择我的模板。

Answer 4

我在使用

将 nbconvert 安装到自定义位置时遇到了这个问题

pip install --target=/foooooo/baaaaar nbconvert

你只需要设置一个JUPYTER_PATH environment variable。

JUPYTER_PATH=/foooooo/baaaaar/share/jupyter

放置自定义 nbconvert 模板的正确位置

Right place to put custom nbconvert templates

python

jinja2

jupyter-notebook

nbconvert