sphinx_gallery.directives#

自訂 Sphinx 指令。

函式#

sphinx_gallery.directives.depart_imgsg_html(self, node)[原始碼]#: HTML 離開節點訪問器函式。

sphinx_gallery.directives.depart_imgsg_latex(self, node)[原始碼]#: LaTeX 離開節點訪問器函式。

sphinx_gallery.directives.imagesg_addnode(app)[原始碼]#: 將 imgsgnode 加入帶有 HTML 和 LaTeX 訪問器函式的 Sphinx 應用程式。

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)[原始碼]#: 複製影像，將 node[uri] 設定為最高解析度的影像並呼叫 visit_image。

類別#

class sphinx_gallery.directives.ImageSg(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[原始碼]#

實作允許選用 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': <function unchanged>, 'class': <function class_option>, 'srcset': <function unchanged>}#: 選項名稱對應到驗證器函式。

optional_arguments = 3#: 在必要引數之後的可選引數數量。

required_arguments = 1#: 必要指令引數的數量。

run()[原始碼]#: 更新節點內容。

class sphinx_gallery.directives.MiniGallery(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[原始碼]#

用於插入迷你範例集的自訂指令。

必要引數為下列一或多項

物件的完整名稱
範例 Python 檔案的路徑字串
範例 Python 檔案的 glob 風格路徑字串

引數字串清單以空格分隔。

迷你範例集將是從該特定命名空間使用該物件的範例集的子集

選項

add-heading 將標題加入迷你範例集。如果有提供引數，則會使用該文字作為標題。否則，會使用預設文字。
heading-level 將標題的標題層級指定為單一字元。如果省略，預設標題層級為 ‘^’。

final_argument_whitespace = True#: 最後一個引數是否可以包含空白？

has_content = True#: 指令是否可以有內容？

option_spec = {'add-heading': <function unchanged>, 'heading-level': <function single_char_or_unicode>}#: 選項名稱對應到驗證器函式。

optional_arguments = 1#: 在必要引數之後的可選引數數量。

required_arguments = 0#: 必要指令引數的數量。

run()[原始碼]#: 從反向參考和範例檔案產生迷你範例集。

class sphinx_gallery.directives.imgsgnode(rawsource='', *children, **attributes)[原始碼]#: Sphinx Gallery 影像節點類別。