sphinx_gallery.scrapers#
用於嵌入圖片的 Scraper。
收集程式碼區塊產生的圖片。
我們原生僅支援 Matplotlib scraper，其他 scraper 應存在於支援它們的模組中 (例如 PyVista、Plotly)。抓取的圖片會以 rst image-sg 指令插入到為每個範例腳本生成的 .rst 檔案中。
函式#
- sphinx_gallery.scrapers.clean_modules(gallery_conf, fname, when)[原始碼]#
移除、卸載或重置模組。
執行腳本後，它可能會載入各種設定，而這些設定不應影響圖庫中的其他範例。
- 參數:
gallery_conf (dict) – 圖庫設定。
fname (str 或 None) – 正在執行的範例。當呼叫此函數進入要建置的範例目錄時，將為 None。
when (str) –
此模組是在範例之前還是之後執行。
只有在可呼叫物件接受 3 個參數時，才會傳遞此參數。
- sphinx_gallery.scrapers.figure_rst(figure_list, sources_dir, fig_titles='', srcsetpaths=None)[原始碼]#
為圖片檔案名稱列表產生 reST。
根據我們有一個或多個圖片，我們使用單個 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'）。這不會在內部使用，但旨在於覆寫 scraper 時使用。
- 回傳值:
rst – 將會呈現為包含圖片的 HTML 的 reStructuredText。這通常由
figure_rst()產生。- 回傳型別: