變更日誌#

v0.18.0#

實作的增強功能

  • 允許停用寫入計算時間 #1385 (bmwiedemann)

  • [ENH] 新增選項，將同一儲存格的多個圖像渲染為單一圖像 #1384 (tsbinns)

已修正的錯誤

  • 修正當自己的索引畫廊為第一個時，indexst 變數不存在的問題 #1383 (lucyleeow)

專案維護

v0.17.1#

已修正的錯誤

  • 修正：修正已儲存的編譯正規表達式的穩定性 #1369 (larsoner)

  • ENH：改進 _sanitize_rst #1366 (timhoffm)

  • 在尋找反向參照時，遵循 prefer_full_module 設定 #1364 (QuLogic)

  • 修正使用 prefer_full_module 時連結到類別屬性的問題 #1363 (QuLogic)

  • 改進 minigallery 指令路徑輸入解析度 #1360 (lucyleeow)

  • 修正：當反向參照關閉時，允許 str 路徑 minigallery 項目 #1355 (lucyleeow)

  • 修正：當使用者傳遞索引時，產生 zip 檔案 #1353 (lucyleeow)

文件

專案維護

v0.17.0#

在此版本中，已捨棄對 Python 3.8 和 Sphinx 4 的支援。現在的最低要求為 Python >= 3.9 和 Sphinx >= 5。

實作的增強功能

已修正的錯誤

  • 修正多模組 intersphinx 登錄的處理方式 #1320 (QuLogic)

  • 錯誤：修正 SyntaxError 的追溯錯誤 #1301 (larsoner)

文件

專案維護

v0.16.0#

Sphinx 7.3.0 及以上版本變更了快取和序列化檢查。現在，您應該傳遞類別或可呼叫物件的完整限定名稱字串，而不是在 sphinx_gallery_conf 中傳遞已實例化的類別（如 ResetArgv()）、類別（如 FileNameSortKey）或可呼叫物件（如 notebook_modification_function）。如果您改用名稱字串，您可以簡單地使用函式，因為使用類別來確保穩定的 __repr__ 將是多餘的。

請參閱 匯入可呼叫物件 以取得詳細資訊。

實作的增強功能

  • 增強：允許使用純列表作為 subsection_order 並支援萬用字元 #1295 (timhoffm)

  • [增強] Minigallery 可以將任意檔案/glob 模式作為輸入 #1226 (story645)

已修正的錯誤

文件

專案維護

v0.15.0#

此版本已停止支援 Python 3.7。現在的需求是 Python >=3.8。新增 Pillow 作為依賴項。

實作的增強功能

已修正的錯誤

  • 修正：提早複製 JupyterLite 內容，使其在 jupyterlite_sphinx build-finished 之前執行 #1213 (lesteve)

  • 錯誤修正：修正 sg_api_usage 的孤立錯誤 #1207 (larsoner)

  • 維護：修正檢查不匹配的「忽略」區塊 #1193 (speth)

  • 避免在反向參考中導入新模組 #1177 (aganders3)

文件

專案維護

v0.14.0#

實作的增強功能

已修正的錯誤

  • 維護：修正 Sphinx 7.2 的問題 #1176 (larsoner)

  • 更新 mpl gui 警告捕捉器以使用新的錯誤訊息 #1160 (story645)

  • 確保 md5sum 產生時的編碼一致 #1159 (sdhiscocks)

  • 維護：修正 app.builder.outdir，因為 Sphinx 現在使用 pathlib #1155 (lucyleeow)

  • 使 _LoggingTee 與 TextIO 相容 #1151 (o-laurent)

  • 維護：將 build_sphinx 替換為 sphinx-build #1139 (oscargus)

  • 將 CSS 檔案中 table.dataframe 的寬度設定為 auto，關閉 #1128 #1137 (photoniker)

文件

專案維護

v0.13.0#

實作的增強功能

  • ENH: 為預設角色建立反向參考 #1122 (StefRe)

  • ENH 在 check_jupyterlite_conf 中，若出現未知的鍵則引發錯誤 #1119 (lesteve)

  • ENH 增加根據內容修改 Jupyterlite 筆記本的功能 #1113 (lesteve)

  • ENH: 新增 WebP 支援 #1111 (StefRe)

已修正的錯誤

API 變更

文件

專案維護

v0.12.2#

已修正的錯誤

v0.12.1#

已修正的錯誤

v0.12.0#

此版本已移除對 Sphinx < 4 的支援。要求為 Sphinx >= 4。

實作的增強功能

已修正的錯誤

文件

專案維護

v0.11.1#

此版本已移除對 Sphinx < 3 的支援。需求為 Sphinx >= 3。

已修正的錯誤

實作的增強功能

v0.11.0#

在此版本中，套用於程式碼輸出的「Out:」前綴現在是從 CSS 偽元素建立，而不是額外的實際文字。如需更多詳細資訊，請參閱#896。

實作的增強功能

圖庫區段的巢狀結構（即圖庫子資料夾）已在#904中實作。如果偏好先前的行為，則可以停用此功能（請參閱文件中的組態選項 nested_sections）（alexisthual）

工具提示現在會覆蓋圖庫項目 commit 36166cd。可能需要調整自訂 CSS（alexisthual）。

  • 子圖庫中區段和範例標題層級的問題 #935

  • 新增寫入巢狀 index.rst 的能力 #855

  • 在執行反向參照時，可選擇使用 module 而非 module_short #950 (ExtremOPS)

  • ENH：更好的深色模式支援 #948 (larsoner)

  • 將 API 參考範例縮圖儲存在共用 div 中 #946 (alexisthual)

  • 新增旗標以忽略 Python 原始碼剖析器中的程式碼區塊 #941 (guberti)

  • 改善 Jupyter 筆記本轉換器對程式碼區塊的處理 #940 (guberti)

  • [MRG] 關於巢狀區段的變更日誌 #926 (alexisthual)

  • 排除隱含反向參照的可能性 #908 (StefRe)

  • [MRG] 處理巢狀結構 #904 (alexisthual)

  • 使用偽元素作為「Out:」前綴 #896 (QuLogic)

  • FIX：修復最新 pytest 的問題 #894 (larsoner)

  • 在逐個檔案的基礎上設定 capture_repr #891 (StefRe)

已修正的錯誤

我們現在使用 CSS 格線而非 float 屬性來顯示圖庫項目 #906，請參閱 遷移指南，以調整縮圖的自訂 CSS (alexisthual)

文件更新

v0.10.1#

此版本已移除對 Python 3.6 的支援。需求為 Python >=3.7。

實作的增強功能

  • 功能請求：在每個或所有範例之後套用 reset_modules #866

  • 啟用 reset_modules 以在範例執行前或執行後，或兩者都執行 #870 (MatthewFlamm)

已修正的錯誤

  • embed_code_links 拋出 <exception: list indices must be integers or slices, not str> 錯誤 #879

  • 0.10.0 版本破壞了 sphinx_gallery.load_style #878

  • 在載入樣式中加入 imagesg 指令 #880 (lucyleeow)

  • 在 sphinx_gallery_conf 中使用布林值設定 'plot_gallery' #863 (timhoffm)

合併的 Pull Request

v0.10.0#

在此版本中，預設的 Sphinx-Gallery .css 檔案已更新，使其名稱都加上了 'sg_' 前綴。詳細資訊請參閱 #845。

實作的增強功能

  • 將 image_scrapers 功能通用化，使其適用於非圖片 #833

  • 新增一個模式，只在 rst 警告時失敗，且不執行範例 #751

  • 新增一個「範本」，方便入門 #555

  • 增強：新增一個設定，用於產生虛擬圖片，以防止缺少圖片的警告 #828 (lucyleeow)

  • 增強：為 matplotlib_scraper 和指令新增 hidpi 選項 #808 (jklymak)

已修正的錯誤

  • 錯誤：在 Binder URL 中，對分支名稱和檔案路徑進行 URL 編碼 #844 (sdhiscocks)

  • 清理產生的 reST 中的 ANSI 字元：從 HTML 輸出中移除 ANSI 字元 #838 (agramfort)

  • 錯誤：在 Python nightly 中釘選 markupsafe 版本 #831 (lucyleeow)

  • 錯誤：修正 test_minigallery_directive 在 Windows 上失敗的問題 #830 (lucyleeow)

  • 錯誤：修正 CI 中找不到 LaTeX 錯誤：找不到檔案 `tgtermes.sty` 的問題 #829 (lucyleeow)

合併的 Pull Request

v0.9.0#

此版本已不再支援 Python 3.5。要求為 Python >=3.6。

實作的增強功能

  • 新增一個模式，如果範例失敗則「跳過」該範例 #789

  • sphinx_gallery_thumbnail_number 是否支援負索引？ #785

  • 設定縮圖樣式 #780

  • 增強：檢查 sphinx_gallery_conf 中的無效鍵 #774

  • 文件：說明如何隱藏下載連結註解 #760

  • 文件：在 projects_list.rst 中使用 intersphinx 參考 #755

  • 將輸出擷取延遲到後續的程式碼區塊 #363

  • 增強：只有在有內容顯示時才加入迷你畫廊 #813 (NicolasHug)

  • 可選的標誌，將圖片擷取延遲到下一個程式碼區塊 #801 (ayshih)

  • 增強：PyQt5 #794 (larsoner)

  • 新增一個設定，用於在發生錯誤時發出警告而不是失敗 #792 (Cadair)

  • 讓 sphinx_gallery_thumbnail_number 支援負索引 #786 (seisman)

  • 使調整圖片大小為縮圖時產生的任何邊框變成透明 #781 (rossbar)

  • 維護：將 travis CI 工作移至 Azure #779 (lucyleeow)

  • 增強，過時：檢查無效的鍵，移除舊的鍵 #775 (larsoner)

已修正的錯誤

  • 標題目標上方空間的自訂 CSS 與 pydata-sphinx-theme 衝突 #815

  • 即使對於沒有範例的物件也會產生迷你畫廊 #812

  • Python nightly 因 Jinja2 從 collections.abc 匯入而失敗 #790

  • test_rebuild 和 test_error_messages 在 travis 上失敗 #777

  • 動畫未在 Read the Docs 上顯示 #772

  • 錯誤：程式碼區塊輸出為空 #765

  • 錯誤：修正 CSS 選擇器 #816 (larsoner)

  • 維護：修正連結測試 #811 (larsoner)

  • 修正 SVG 預設縮圖支援 #810 (jacobolofsson)

  • 澄清自訂 gallery_dirs 的清除文件 #798 (timhoffm)

  • 維護：在 azure Python nightly 中指定 Jinja2 版本 #793 (lucyleeow)

  • 錯誤：如果最後一個區塊為空則移除 #791 (lucyleeow)

  • 在 README 中以 Azure 徽章取代 Travis CI 徽章 #783 (sdhiscocks)

  • 指向最新的 re 文件 #778 (dstansby)

合併的 Pull Request

v0.8.2#

啟用在 readthedocs 上渲染 HTML 動畫的功能。

實作的增強功能

  • 文件：擴充 sphinx_gallery_thumbnail_path 的說明 #764 (lucyleeow)

  • 增強：新增 run_stale_examples 配置變數 #759 (larsoner)

  • 可選擇停用範例標頭中的註解 #757

  • 新增 show_signature 選項 #756 (jschueller)

  • 增強：讓 HTML 輸出樣式與 jupyter 類似 #752 (larsoner)

  • 增強：新增 reST 註解，設為唯讀 #750 (larsoner)

  • 將產生的 rst 檔案中的警告和錯誤關聯回原始 Python 檔案/防止意外寫入產生的檔案 #725

已修正的錯誤

  • 範例展示區無法使用 #753

  • 文件：修改 configuration.rst 中的 run_stale_examples 命令 #763 (lucyleeow)

  • 文件：更新 projects_list 中的連結 #754 (lucyleeow)

  • 啟用在 readthedocs 上渲染 HTML 動畫的功能 #748 (sdhiscocks)

合併的 Pull Request

v0.8.1#

修正 Windows 路徑的 Binder 標誌圖片檔案。

已修正的錯誤

  • sphinx_gallery/tests/test_full.py::test_binder_logo_exists 失敗（路徑明顯錯誤） #746

  • 錯誤：Windows 的相對路徑在 _static Binder 標誌中發生錯誤 #744

  • 錯誤：複製 Binder 標誌以避免 Windows 磁碟機相對路徑錯誤 #745 (lucyleeow)

合併的 Pull Request

v0.8.0#

設定 thumbnail_size 的預設值將在 0.9.0 版本中從 (400, 280) (CSS 指定的最大尺寸的 2.5 倍) 變更為 (320, 224) (CSS 指定的最大尺寸的 2 倍)。

實作的增強功能

  • 將命令列引數傳遞給範例 #731

  • 限制筆記本中 rst 對 md 的支援 #219

  • 為較新版本的 matplotlib 啟用動畫的 ffmpeg #733 (dopplershift)

  • 實作將命令列引數傳遞給範例腳本的選項 #732 (mschmidt87)

  • 增強：不允許輸入 #729 (larsoner)

  • 新增對筆記本的圖片連結和資料 URI 的支援 #724 (sdhiscocks)

  • 支援 reST 中的標題轉為 MD #723 (sdhiscocks)

  • 增強：支援 pypandoc 將 rst 轉換為 ipynb 的 md #705 (lucyleeow)

  • 增強：使用更廣泛的動畫定義 #693 (larsoner)

已修正的錯誤

  • _repr_html_ 未在 RTD 上顯示 #736

  • Binder 圖示是硬式編碼的，這會在某些瀏覽器上導致載入失敗 #735

  • 如何在不執行範例腳本的情況下抓取圖片 #728

  • sphinx-gallery/0.7.0：建構文件時發生 TypeError: ‘str’ object is not callable #727

  • 縮圖過採樣 #717

  • 使用預先建構的展示區 #704

  • 呼叫 “plt.show()” 會產生不雅的警告 #694

  • 在 v0.6.2 穩定版文件中搜尋無法運作 #689

  • 修正 pypandoc 的記錄訊息 #741 (lucyleeow)

  • 使用本機 binder 標誌 svg #738 (lucyleeow)

  • 錯誤：修正 scraper 錯誤的處理方式 #737 (larsoner)

  • 改善自訂圖片抓取工具範例的文件 #730 (mschmidt87)

  • 使 md5 雜湊獨立於平台行尾 #722 (sdhiscocks)

  • 維護：處理 mayavi #720 (larsoner)

  • 文件：釐清 thumbnail_size 並注意預設值的變更 #719 (lucyleeow)

  • 錯誤：一律執行連結 #714 (larsoner)

  • 文件：正確記錄選項 #711 (larsoner)

  • 錯誤：檢查 'capture_repr' 和 'ignore_repr_types' #709 (lucyleeow)

  • 文件：更新 Sphinx 網址 #708 (lucyleeow)

  • 錯誤：將相對路徑用於 zip 下載 #706 (pmeier)

  • 修正：使用 master 在 nightly 上建構 #703 (larsoner)

  • 維護：修正 CircleCI #701 (larsoner)

  • 啟用在 readthedocs 上渲染 html 的功能 #700 (sdhiscocks)

  • 移除 matplotlib agg 警告 #696 (lucyleeow)

合併的 Pull Request

v0.7.0#

開發人員變更#

  • 使用 Sphinx 錯誤而非內建錯誤。

實作的增強功能

  • 增強：使用 Sphinx 錯誤 #690 (larsoner)

  • 增強：新增對 FuncAnimation 的支援 #687 (larsoner)

  • 用於插入迷你展示區的 Sphinx 指令 #685 (ayshih)

  • 提供一個 Sphinx 指令來插入迷你展示區 #683

  • 增強：將交叉引用標籤新增至模板 module.rst #680 (lucyleeow)

  • ENH：新增 show_memory 擴充 API #677 (larsoner)

  • 支援 GPU 記憶體記錄 #671

  • ENH：為縮圖新增 alt 屬性 #668 (lucyleeow)

  • ENH：為索引中的縮圖提供更豐富的「alt」屬性 #664

  • ENH：為圖片提供更豐富的「alt」屬性 #663 (lucyleeow)

  • ENH：在請求時使用 optipng #656 (larsoner)

  • 縮圖導致圖庫頁面過大且載入時間過長 #655

  • MAINT：更佳的錯誤訊息 #600

  • 圖片標籤更豐富的「alt」屬性 #538

  • ENH：輕鬆連結至「使用 my_function 的範例」 #496

  • 子圖庫應使用單獨的「圖庫 rst」檔案產生 #413

  • matplotlib 動畫支援 #150

已修正的錯誤

  • 為 module.rst 中的類別新增反向參照標籤 #688 (lucyleeow)

  • 修正反向參照檢查以考慮波浪符號的使用 #684 (ayshih)

  • 修正 test_full 中 numpy RandomState 的 regex #682 (lucyleeow)

  • 修正測試 regex 以在 html 中搜尋 numpy 資料 #681

  • FIX：修正 sys.stdout 修補 #678 (larsoner)

  • check-manifest 導致 master 失敗 #675

  • 如果記錄器在不同的儲存格中建立，則不會捕獲記錄器的輸出 #672

  • FIX：從標題中移除換行符號 #669 (larsoner)

  • BUG Tinybuild autosummary 連結在 Sphinx 開發版中失敗 #659

文件

合併的 Pull Request

v0.6.2#

  • 由於 v0.6.1 中缺少 CSS 檔案的修補版本。已在 CI 中新增 Manifest 檢查。

實作的增強功能

  • 我該如何最佳地引用 sphinx-gallery？#639

  • MRG，ENH：新增 Zenodo 徽章 #641 (larsoner)

已修正的錯誤

  • BUG：錯誤的 pandas intersphinx URL #646

  • CSS 未包含在 wheels 中？#644

  • BUG：修正 CSS 包含並在 CI 中新增 manifest 檢查 #648 (larsoner)

  • 更新 pandas intersphinx URL #647 (lucyleeow)

合併的 Pull Request

v0.6.1#

開發人員變更#

  • 新增 Zenodo 整合。此版本適用於 Zenodo 拾取。

實作的增強功能

  • 允許 pathlib.Path 作為 backreferences_dir 選項 #635

  • ENH：允許 backrefences_dir 為 pathlib 物件 #638 (lucyleeow)

已修正的錯誤

  • 從圖庫建立連結至文件的 TypeError #634

  • BUG：檢查檔案名稱是否有空格 #636 (lucyleeow)

  • 修正錯誤訊息中遺失的空格。 #632 (anntzer)

  • BUG：範例檔案名稱中的空格會中斷影像連結 #440

合併的 Pull Request

v0.6.0#

開發人員變更#

  • 減少硬依賴項的數量，並新增 dev-requirements.txt。

  • AppVeyor 從 Python 3.6 升級至 3.7。

  • 分割 CSS 並建立載入 CSS 的子擴充。

實作的增強功能

已修正的錯誤

合併的 Pull Request

v0.5.0#

開發者變更#

  • 區分了追蹤 master 的「dev」文件和追蹤發布版本的「stable」文件。

  • 新增了官方的 jpeg 支援。

不相容的變更#

  • 停止支援 Sphinx < 1.8.3。

  • 停止支援 Python < 3.5。

  • 新增了 capture_repr 設定，預設值為 ('_repr_html_', __repr__')。這可能會導致在現有專案中捕獲不必要的輸出。設定 capture_repr: () 以恢復到此版本之前的行為。

實作的增強功能

  • 說明圖片 scraper 的輸入 #472

  • 像在 Jupyter 中一樣捕獲 HTML 輸出 #396

  • 功能請求：新增不同儲存格分隔的選項 #370

  • 將 sphinx 擴充功能標記為並行寫入安全 #561 (astrofrog)

  • ENH：支援連結到內建模組 #558 (larsoner)

  • ENH：新增官方 JPG 支援並改善測試 #557 (larsoner)

  • [MRG] ENH：捕獲最後一個運算式的 'repr' #541 (lucyleeow)

  • 同時搜尋 'README' 和 'readme' #535 (revesansparole)

  • ENH：加速建置 #526 (larsoner)

  • ENH：新增即時物件參考和方法 #525 (larsoner)

  • ENH：同時顯示記憶體使用量 #523 (larsoner)

  • [MRG] EHN 支援 #%% 儲存格分隔符號 #518 (lucyleeow)

  • MAINT：移除對舊版 Python 和 Sphinx 的支援 #513 (larsoner)

已修正的錯誤

合併的 Pull Request

v0.4.0#

開發者變更#

  • 新增了用於外部 scraper 的私人 API 合約，以支援基於字串的功能，請參閱

  • 現在會捕獲標準錯誤，並與標準輸出一起顯示。

  • 現在會從圖片縮圖工具提示中移除一些 sphinx 標記。

不相容的變更#

  • v0.4.0 將是最後一個支援 Python <= 3.4 的版本。

  • 今後，我們將只支援每次 sphinx-gallery 發布時最新的兩個穩定 Sphinx 版本。

實作的增強功能

已修正的錯誤

v0.3.1#

錯誤修復版本：新增遺失的檔案，該檔案會阻止 “pip installing” 套件。

已修正的錯誤

  • 版本 0.3.0 在 pypi 上損壞 #459

v0.3.0#

不相容的變更#

  • 輸出圖形的編號總是 1, 2, …, number_of_figures，而在 0.2.0 中，它會遵循 matplotlib 圖形的編號。如果您在您的 .rst 文件中明確包含一些由 sphinx-gallery 使用 .. figure 指令產生的圖形，如果您的範例使用非預設的 matplotlib 圖形編號 (例如，如果您使用 plt.figure(0))，您可能需要調整它們的路徑。請參閱 #464 <https://github.com/sphinx-gallery/sphinx-gallery/issues/464> 以了解更多詳細資訊。

開發者變更#

  • 已停止支援 Sphinx <= 1.4。

  • 重構以進行獨立的 rst 檔案建構。函式 sphinx_gallery.gen_rst.generate_file_rst 在執行原始碼的每個區塊時不再組成 rst 檔案。目前，執行範例腳本 execute_script 是一個獨立的函式，並以列表形式傳回每個原始碼區塊輸出 rst 表示的結構。generate_file_rst 在需要時呼叫腳本的執行，然後從 rst 輸出組成 rst 文件，其中包含範例的散文、程式碼和輸出，並直接儲存到檔案中，包括 binder 徽章、下載按鈕和計時統計資料的註解。

  • Binder 連結配置變更。BinderHub 的配置值已從 url 變更為 binderhub_url，以便更明確。舊的配置鍵 (url) 將在 v0.4.0 版本中被棄用)

  • 支援透過 'junit' 配置值產生 JUnit XML 摘要檔案，這對於在 CircleCI 等 CI 服務上建置很有用。請參閱相關的 CircleCI 文件 和 部落格文章。

已修正的錯誤

  • 第一個圖庫繪圖使用 .matplotlibrc 而不是 matplotlib 預設值 #316

合併的 Pull Request

v0.2.0#

新功能#

  • 新增透過 binder 配置自動產生範例的 Binder 連結的實驗性支援。請注意，此 API 未來可能會變更。#244 和 #371。

  • 新增 ignore_pattern 可配置選項，允許不將某些 Python 檔案加入圖庫。請參閱 #346 以了解更多詳細資訊。

  • 支援 ‘RGBA’ 空間中的自訂預設縮圖 #375

  • 允許僅標題 -> 使用標題作為第一段 #345

錯誤修正#

  • 修正在路徑中包含“.py”的專案上字串取代的錯誤。請參閱 #322 和 #331 以了解更多詳細資訊。

  • 修正跨單元格的 __future__ 匯入。請參閱 #308 以了解更多詳細資訊。

  • 修正當地區設定不是 UTF-8 時的編碼相關問題。請參閱 #311 以了解更多詳細資訊。

  • 在詳細模式下，範例輸出會在範例執行期間列印到主控台，而不是僅在最後。請參閱 #301 以了解需要此功能的使用案例。

  • 修正在 sphinx 1.7 中 SphinxDocLinkResolver 錯誤。請參閱 #352 以了解更多詳細資訊。

  • 修正 file_pattern 和 expected_failing_examples 之間意外的互動。參見 #379 和 #335

  • 修正：為輸出使用無樣式的 pygments #384

  • 修正：路徑以「/」結尾的圖庫名稱 #372

  • 修正標題偵測邏輯。 #356

  • 修正：使用 docutils_namespace 以避免在 sphinx 1.8dev 中出現警告 #387

不相容的變更#

  • 移除了當設定 SKLEARN_DOC_OPTIPNG 變數時觸發的 optipng 功能。參見 #349 以了解更多詳細資訊。

  • Backreferences_dir 現在是強制性的 #307

開發者變更#

  • 已停止支援 Sphinx <= 1.4。

  • 在 test_gen_gallery.py 中加入 SphinxAppWrapper 類別 #386

  • 關於如何發布的注意事項 #360

  • 加入 codecov 支援 #328

v0.1.13#

新功能#

  • 加入 min_reported_time 可設定項。對於執行速度快於該臨界值（以秒為單位）的範例，將不會報告執行時間。

  • 新增 thumbnail_size 選項 #283

  • 對所有函式參考解析使用 intersphinx #296

  • 僅適用於下載的 Sphinx 指令 #298

  • 允許排序子章節檔案 #281

  • 我們建議針對 plot_gallery 使用字串而不是 Python 布林值，例如 'True' 而不是 True，因為這樣可以避免在透過 sphinx-build 的命令列開關控制此值時出現關於 unicode 的警告

錯誤修正#

  • doc_resolv 中的當機，在 js_index.loads 中 #287

  • 修正 gzip/BytesIO 錯誤 #293

  • 停用 Travis 提供的 virtualenv #294

開發者變更#

  • 將文件從 Circle CI 推送到 github #268

  • 向 sphinx 報告版本。 #292

  • 對日誌格式的細微變更。 #285 和 #291

v0.1.12#

新功能#

  • 實作明確的順序排序鍵，以指定圖庫中子章節的順序。請參閱 #37、#233 和 #234 中的討論

  • 清除建置期間的控制台輸出 #250

  • 新組態測試 #225

錯誤修正#

  • 在執行每個範例之前重設 sys.argv。參見 #252 以了解更多詳細資訊。

  • 在文件解析器中正確地重新引發錯誤。參見 #264。

  • 盡可能允許並使用 https 連結 #258。

  • 逸出任何 HTML 特殊字元的工具提示。 #249

文件#

  • 更新指向 numpy 的連結以指向最新版本 #271

  • 新增文件相依性。 #267

v0.1.11#

文件#

  • 常見問題已新增至文件中。為什麼 __file__ 沒有定義？

錯誤已修正#

  • 在 #242 中變更 Sphinx app 物件的屬性名稱

v0.1.10#

錯誤已修正#

  • 修正 #218 中引入的影像路徑處理錯誤

v0.1.9#

不相容的變更#

  • Sphinx Gallery 的範例反向參考預設為停用。現在使用者有責任將其開啟，並設定儲存檔案的目錄。請參閱 #126 和提取請求 #151 中的討論。

錯誤已修正#

  • 修正 windows 建置中的下載 zip 檔案路徑。參見 #218

  • 修正內嵌遺失連結。參見 #214

開發者變更#

  • 將測試移至 py.test

  • 在文件中包含 github 儲存庫的連結

v0.1.8#

新功能#

  • 在程式碼連結工具提示中捨棄樣式。已替換為由瀏覽器管理的 title 屬性。

  • 當內嵌連結時，圖庫輸出較短

  • Circle CI 測試

錯誤修正#

  • 即使範例有語法錯誤，Sphinx-Gallery 也能建置。參見 #177

  • Sphinx-Gallery 現在可以透過從任何路徑直接呼叫 sphinx-build 來建置，無需從原始碼目錄執行 Makefile。參見 #190 以了解更多詳細資訊。

v0.1.7#

錯誤修正#

  • 發布的 Sphinx 1.5 對於自動產生的檔案有新的命名慣例，並中斷了 Sphinx-Gallery 文件掃描器。已在 #178 中修正，適用於連結到使用 Sphinx<1.5 和 1.5 版之後的新文件所產生的文件

  • 程式碼連結工具提示現在與程式碼左對齊

新功能#

  • Windows 上 Sphinx-Gallery 的開發支援 #179 & #182

v0.1.6#

新功能#

  • 可執行腳本，將 Python 腳本轉換為 Jupyter Notebooks #148

錯誤修正#

  • 如果無法將 matplotlib 後端設定為 'agg'，Sphinx-Gallery 現在會引發例外狀況。例如，如果 matplotlib.pyplot 是在 conf.py 中匯入的，可能會發生這種情況。參見 #157 以了解更多詳細資訊。

  • 當模組在沒有屬性的情況下使用時，修正 backreferences.identify_names #173。關閉 #172 和 #149

  • 當範例圖庫的主要目錄中不存在 README.txt 時，引發 FileNotFoundError(#164)。並且在讀取 README.txt 後包含額外的空行，以取得正確的 html 檔案呈現結果。(#165)

  • 在 PyPI 發行版本中提供授權檔案

v0.1.5#

新功能#

  • CSS。現在，原始碼區塊上會顯示工具提示，以使文件解析功能更容易被發現。原始碼區塊中的函式呼叫是其線上文件的超連結。

  • 下載按鈕在 Sphinx 提供的所有主題中都具有更好的外觀

開發者變更#

  • 支援 Sphinx-Gallery 文件本機建置的即時主題變更。將變數 theme 傳遞給 make 目標會以新的主題建置文件。所有 sphinx 主題都可用，再加上在值 rtd 下的線上閱讀文件主題，如此用法範例所示。

    $ make html theme=rtd

  • 測試 Ubuntu 14 套件上的 Sphinx Gallery 支援，捨棄 Ubuntu 12 支援。在 conda 環境中捨棄對 Python 2.6 的支援

v0.1.4#

新功能#

  • 增強下載按鈕的 CSS

  • 圖庫末尾的下載按鈕，可將所有 Python 腳本或 Jupyter Notebooks 一起下載到 zip 檔案中。新的組態變數 download_all_examples 可切換此效果。預設為啟用

  • 可下載的 zip 檔案，其中包含每個圖庫的所有範例（以 Python 腳本和 Notebooks 的形式）

  • 改進 Jupyter Notebook 文字區塊中 rst 指令到 markdown 的轉換

錯誤修正#

  • 當在範例中匯入 seaborn 時，繪圖樣式偏好會轉移到之後執行的繪圖。設定 CI 的方式讓使用者可以遵循如何在 conda 環境中取得相容版本的 mayavi-pandas-seaborn 和 nomkl，以使用所有可用的功能。

  • 修正從範例 rst 到 Jupyter Notebook 文字的數學轉換，以適用於內嵌數學和多行方程式

v0.1.3#

新功能#

  • 在 sphinx 建置結束時，顯示失敗範例的摘要及追溯資訊。預設情況下，如果範例失敗，建置會以退出碼 1 結束。可以在 conf.py 中定義預期會失敗的範例列表，並以退出碼 0 結束建置。或者，也可以在一個範例失敗時立即結束建置。

  • 在建置過程中，於主控台中列印所有範例的計算時間彙總和排序列表。

  • 對於產生多個圖表的範例，設定縮圖影像。

  • plot_gallery 和 abort_on_example_error 選項現在可以在 sphinx_gallery_conf 中指定。建置選項（傳遞給 sphinx-build 的 -D 旗標）的優先順序高於 sphinx_gallery_conf 選項。

錯誤修復#

  • 每次建置都會重試失敗的範例

v0.1.2#

錯誤修復#

  • 現在會執行使用 if __name__ == '__main__' 守護的範例

  • 在非筆記本範例中，程式碼輸出和程式碼來源之間新增垂直間距

v0.1.1#

錯誤修復#

  • 還原 html-noplot 功能

  • Gallery CSS 現在隱式地強制縮圖寬度

v0.1.0#

重點#

範例腳本現在可以下載為 IPython Notebooks #75

新功能#

  • 可設定檔案名稱模式，以選擇在建置 Gallery 時執行哪些範例腳本

  • 範例腳本更新檢查現在是透過 md5sum 檢查而不是日期

  • 損壞的範例現在會在 Gallery 視圖中顯示損壞的縮圖，並且在呈現的範例中列印追溯資訊。使用者也可以設定建置程序在範例失敗時立即中止。

  • 按腳本大小排序範例

  • 改進範例樣式

v0.0.11#

重點#

此版本包含 PR #36 的 Gallery 筆記本樣式範例

不相容的變更#

Sphinx-Gallery 將其 python 模組名稱重新命名為 sphinx_gallery，這遵循了 #47 中提出的討論，並以 #66 解決

Gallery 設定字典也將其名稱變更為 sphinx_gallery_conf

從 PR #36 中，決定採用影像、縮圖和參考的新命名空間慣例。請參閱 評論

v0.0.10#

重點#

此版本允許使用反向參考。此功能包含使用特定函數的範例列表之精細範例 Gallery。 #26

新功能#

  • 將 Sphinx-Gallery 的本機副本放置在您專案中的 Shell 腳本

  • 支援 Gallery 中的 Mayavi 圖表

在此頁面上