sphinx_gallery.notebook

Jupyter Notebook のパーサー。

Jupyter Notebook の情報を保持するクラス

関数

sphinx_gallery.notebook.add_code_cell(work_notebook, code)

ノートブックにコードセルを追加します。

パラメーター：

code (str) – セルの内容

sphinx_gallery.notebook.add_markdown_cell(work_notebook, markdown)

ノートブックにマークダウンセルを追加します。

パラメーター：

markdown (str) – マークダウンセルの内容。

sphinx_gallery.notebook.convert_code_to_md(text)

コードブロックを、Markdown が推奨するバッククォート表記を使用するように書き換えます。

バッククォート表記は構文ハイライトを保持します。

パラメーター：

text (str) – 主にマークダウンテキストに変換された文字列。コードブロック形式のコードブロックを0個、1個、または複数含む場合があります。

sphinx_gallery.notebook.directive_fun(match, directive)

ディレクティブを埋め込むためのヘルパー関数。

sphinx_gallery.notebook.fill_notebook(work_notebook, script_blocks, gallery_conf, target_dir)

Jupyter Notebook のセルを書き込みます。

利用可能な場合は、pypandoc を使用して rst をマークダウンに変換します。

パラメーター：

script_blocks (list) – 各リスト要素は、(ラベル、内容、行番号) のタプルである必要があります。

sphinx_gallery.notebook.generate_image_src(image_path, gallery_conf, target_dir)

“notebook_images” 設定に従って、ノートブックの画像パスを変更します。

URL は変更されません。“notebook_images” 設定が文字列の場合、“src_dir” を基準とした画像パスのプレフィックスとして使用されます。“notebook_images” が`True` の場合、画像は URI として埋め込まれます。“notebook_images” が`False` の場合、“file://” がプレフィックスとして追加されます。

sphinx_gallery.notebook.jupyter_notebook(script_blocks, gallery_conf, target_dir)

Jupyter Notebook ファイルをセル単位で生成します。

パラメーター：

• script_blocks (list) – スクリプト実行セル。

• gallery_conf (dict) – sphinx-gallery 設定辞書。

• target_dir (str) – ノートブックの保存先パス。相対パスが必要な場合に使用されます。

sphinx_gallery.notebook.jupyter_notebook_skeleton()

Jupyter Notebook の要素を含む辞書を返します。

sphinx_gallery.notebook.promote_jupyter_cell_magic(work_notebook, markdown)

テキストブロック内の Jupyter セルマジックをノートブックのコードブロックに昇格させます。

Jupyter セルマジック（例： %%bash）で始まるコードブロックを探してマークダウンテキストブロックを解析します。見つかった場合は、その前のテキストとコード（実行可能なコードブロックとして）を work_notebook に追加します。残りのテキストは返されます。

パラメーター：

markdown (str) – マークダウンセルの内容。

sphinx_gallery.notebook.python_to_jupyter_cli(args=None, namespace=None, sphinx_gallery_conf=None)

Jupyter Notebook レンダラーをコマンドラインに公開します。

ArgumentParser.parse_args と同じ引数を取ります。`sphinx_gallery_conf` は `conf.py` と同じように機能します。

sphinx_gallery.notebook.rst2md(text, gallery_conf, target_dir, heading_levels)

docstring とテキストブロックからの reST を、Jupyter Notebook 用のマークダウンに変換します。

パラメーター：

• text (str) – MD に変換する reST 入力

• gallery_conf (dict) – sphinx-gallery 設定辞書。

• target_dir (str) – ノートブックの保存先パス。相対パスが必要な場合に使用されます。

• heading_levels (dict) – 見出しスタイル` (over_char, under_char)` の見出しレベルへのマッピング。`over_char` は下線がのみ存在する場合`None`であることに注意してください。

sphinx_gallery.notebook.save_notebook(work_notebook, write_file)

Jupyter work_notebook を write_file に保存します。