Sphinx-Gallery#

一個 Sphinx 擴充功能，可從任何 Python 腳本集建立 HTML 範例集。查看文件，以了解如何使用它以及更多資訊…

特色#

🚀 自動建立範例集，方法是執行純 Python 範例腳本，同時捕獲輸出 + 圖形，將它們渲染成 reST 文件，並由 Sphinx 建置到您的文件中
📝 在您的範例 Python 文件中嵌入 reST，讓您可以將敘述性內容與在文件中產生圖表的程式碼交織在一起。Sphinx-Gallery 還會自動為每個範例頁面產生 Jupyter Notebook。
📋 為 API 文件新增迷你範例集。Sphinx-Gallery 可以產生迷你範例集，列出所有使用特定函數/方法/等的範例。
🔗 將 intersphinx 連結新增到您的範例。Sphinx-Gallery 可以自動為範例中使用的函數/方法/類別新增 API 文件連結（適用於任何使用 intersphinx 的 Python 模組）。
🗒️ 管理多個範例集，以建立並嵌入多個範例資料夾的範例集。

您可以使用 pip 直接安裝

$ pip install sphinx-gallery

提示

Sphinx-Gallery 也支援從 Matplotlib 和基於 Matplotlib 的套件（例如 Seaborn）抓取圖像。我們建議安裝系統 optipng 二進位檔，以減少產生的 PNG 檔案的大小。

如果您想引用 Sphinx-Gallery，可以使用我們的 Zenodo 儲存庫。