sphinx_gallery.directives#

カスタム Sphinx ディレクティブ。

関数#

sphinx_gallery.directives.depart_imgsg_html(self, node)[ソース]#: HTML depart ノードビジター関数。

sphinx_gallery.directives.depart_imgsg_latex(self, node)[ソース]#: LaTeX depart ノードビジター関数。

sphinx_gallery.directives.imagesg_addnode(app)[ソース]#: imgsgnode を Sphinx アプリに追加し、HTML および LaTeX 用のビジター関数を提供します。

sphinx_gallery.directives.visit_imgsg_html(self, node)[ソース]#

‘srcset’の設定に応じて HTML イメージタグを処理します。

‘srcset’がNoneでない場合は、画像をコピーし、‘srcset’を使用した画像 HTML タグを生成し、HTML bodyに追加します。‘srcset’がNoneの場合は、nodeでvisit_imageを実行します。

sphinx_gallery.directives.visit_imgsg_latex(self, node)[ソース]#: 画像をコピーしてノード[uri]を最高解像度の画像に設定し、visit_imageを呼び出します。

クラス#

クラス sphinx_gallery.directives.ImageSg(name, 引数, オプション, コンテンツ, lineno, コンテンツ_オフセット, ブロック_テキスト, ステータス, 状態_機械)[ソース]#

hidpi オプションの画像の使用許可するためのディレクティブを実装します。

image_srcset のコンフィギュレーションオプションと併用することを想定しています。

たとえば：

.. image-sg:: /plot_types/basic/images/sphx_glr_bar_001.png
    :alt: bar
    :srcset: /plot_types/basic/images/sphx_glr_bar_001.png,
             /plot_types/basic/images/sphx_glr_bar_001_2_00x.png 2.00x
    :class: sphx-glr-single-img

結果の html は以下のようになります。

<img src="sphx_glr_bar_001_hidpi.png"
    srcset="_images/sphx_glr_bar_001.png,
            _images/sphx_glr_bar_001_2_00x.png 2x",
    alt="bar"
    class="sphx-glr-single-img" />

final_argument_whitespace = False#: 最後の引数がホワイトスペースを含む場合がありますか？

has_content = False#: ディレクティブがコンテンツを持つことができますか？

option_spec = {'alt': <関数 unchanged>, 'class': <関数 class_option>, 'srcset': <関数 unchanged>}#: オプションの名前からバリデータ関数へのマッピング。

optional_arguments = 3#: 必須引数の後のオプション引数の数。

required_arguments = 1#: 必須ディレクティブ引数の数。

run()[ソース]#: ノードのコンテンツを更新します。

クラス sphinx_gallery.directives.MiniGallery(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[ソース]#

ミニギャラリーを挿入するカスタムディレクティブです。

必須引数は、次の 1 つまたは複数です。

オブジェクトの完全修飾名
Python ファイルの例へのパスライク文字列
Python ファイルの例への glob スタイルのパスライク文字列

引数の文字列リストはスペースで区切られます。

ミニギャラリーは、その特定のネームスペースからそのオブジェクトを利用するギャラリーの例の部分集合になります。

オプション

add-heading はミニギャラリーにヘッダーを追加します。引数が指定されている場合、ヘッダーにそのテキストを使用します。それ以外の場合は、既定のテキストを使用します。
heading-level は、単一文字として見出しの見出しレベルを指定します。省略した場合は、既定の見出しレベルは ‘^’ になります。

final_argument_whitespace = True#: 最後の引数がホワイトスペースを含む場合がありますか？

has_content = True#: ディレクティブがコンテンツを持つことができますか？

option_spec = {'add-heading': <関数 unchanged>, 'heading-level': <関数 single_char_or_unicode>}#: オプションの名前からバリデータ関数へのマッピング。

optional_arguments = 1#: 必須引数の後のオプション引数の数。

required_arguments = 0#: 必須ディレクティブ引数の数。

run()[ソース]#: バックリファレンスと例ファイルからミニギャラリーを生成します。

クラス sphinx_gallery.directives.imgsgnode(rawsource='', *children, **attributes)[ソース]#: Sphinxギャラリーの画像ノードクラス。