Sphinx-Gallery 工具#
將 Python 腳本轉換為 Jupyter 筆記本#
Sphinx Gallery 也將其 Python 原始碼至 Jupyter 筆記本轉換器公開為可執行的腳本。要使用此工具,只需呼叫該腳本並將 Python 原始碼檔案作為參數傳遞。
$ python -m sphinx_gallery_py2jupyter python_script.py
將 Sphinx-Gallery 嵌入您的文件腳本擴充功能中#
如果您想將 Sphinx-Gallery 嵌入您的專案中,而不是將其作為依賴項,您可以呼叫我們 Sphinx 擴充功能資料夾內的嵌入腳本。
# Script to do a local install of sphinx-gallery
rm -rf tmp sphinx_gallery
easy_install -Zeab tmp sphinx-gallery
cp -vru tmp/sphinx-gallery/sphinx_gallery/ .
echo "Remember to add sphinx_gallery to your version control"
echo "Use in case of git:"
echo "$ git add sphinx_gallery"
這將直接從 PyPI 下載我們最新的發佈程式碼,並將其儲存到目前的資料夾中。這是 Sphinx-Gallery 模組的精簡版本,可納入您的專案中。您也應該將其新增至您的版本控制系統。
Minigallery 指令#
Sphinx-Gallery 提供 minigallery
指令,讓您可以輕鬆地將精簡版的展示圖庫新增至您的文件中。詳情請參閱 新增迷你展示圖庫。