sphinx_gallery.scrapers#
画像を埋め込むためのスクレーパー。
コードブロックによって生成された画像を収集します。
ネイティブでサポートしているスクレーパーは Matplotlib のみです。その他のスクレーパーは、それらをサポートするモジュール（例: PyVista、Plotly）に存在する必要があります。スクレイピングされた画像は、各サンプルスクリプト用に生成された .rst ファイルに、rst image-sg ディレクティブとして挿入されます。
関数#
- sphinx_gallery.scrapers.clean_modules(gallery_conf, fname, when)[ソース]#
モジュールを削除、アンロード、またはリセットします。
スクリプトが実行された後、ギャラリー内の他のサンプルに影響を与えたくないさまざまな設定をロードする可能性があります。
- sphinx_gallery.scrapers.figure_rst(figure_list, sources_dir, fig_titles='', srcsetpaths=None)[ソース]#
画像ファイル名のリストに対して reST を生成します。
1つ以上の図があるかどうかに応じて、単一の rst 呼び出しで「image」を使用するか、水平リストを使用します。
- パラメータ:
figure_list (list) – 図の絶対パスの文字列のリスト。
sources_dir (str) – Sphinx ドキュメントのソースの絶対パス
fig_titles (str) – 図のタイトル。タイトルが見つからない場合は空の文字列。現在、matplotlib の図でのみサポートされており、デフォルトは '' です。
srcsetpaths (list または None) – 絶対パスを含む辞書のリスト。空の場合、srcset フィールドには図のパスが入力されます (
image_srcset設定オプションを参照)。それ以外の場合、各辞書は {0: /images/image.png, 2.0: /images/image_2_00x.png} の形式になります。キーは倍率であり、内容は上で作成された画像へのパスです。
- 戻り値:
images_rst (str) – ドキュメントに画像を埋め込むための rst コード
rst コードには、カスタムの
image-sgディレクティブがあり、以下を可能にします複数の解像度の画像をサービスする例:
`` (srcset: /plot_types/imgs/img_001.png,) – /plot_types/imgs/img_2_00x.png 2.00x``
- sphinx_gallery.scrapers.matplotlib_scraper(block, block_vars, gallery_conf, **kwargs)[ソース]#
Matplotlib の画像をスクレイピングします。
- パラメータ:
block (sphinx_gallery.py_source_parser.Block) – 実行されるコードブロック。形式 (ラベル、コンテンツ、行番号)。
block_vars (dict) – ブロック変数の辞書。
gallery_conf (dict) – Sphinx-Gallery の構成が含まれています。
**kwargs (dict) –
savefig()に渡す追加のキーワード引数（例:format='svg'）。特に、formatキーワード引数は、出力ファイルのファイル拡張子を設定するために使用されます (現在、'png'、'jpg'、'svg'、'gif'、'webp' のみがサポートされています)。これは内部的には使用されませんが、スクレーパーをオーバーライドするときに使用することを目的としています。
- 戻り値:
rst – 画像を含む HTML にレンダリングされる reStructuredText。これは、多くの場合
figure_rst()によって生成されます。- 戻り値の型:
- sphinx_gallery.scrapers.save_figures(block, block_vars, gallery_conf)[ソース]#
サンプルコードブロックのすべての開いている図を保存します。
- パラメータ:
block (sphinx_gallery.py_source_parser.Block) – 実行されるコードブロック。形式 (ラベル、コンテンツ、行番号)。
block_vars (dict) – ブロック変数の辞書。
gallery_conf (dict) – Sphinx-Gallery の構成が含まれています。
- 戻り値:
images_rst – ドキュメントに画像を埋め込むための rst コード。
- 戻り値の型: