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文件并将其存储在nbconvert中来告诉~/.jupyter查找模板。

我将其用于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。

保存自定义模板（以便nbconvert可以全局访问它们）的推荐位置是jupyter数据目录：

共享/ 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模板的正确位置

4 个答案: