变更日志#

v0.18.0#

实现的增强功能

  • 允许禁用写入计算时间 #1385 (bmwiedemann)

  • [ENH] 添加选项以将来自同一单元格的多个图像渲染为单个图像 #1384 (tsbinns)

修复的错误

  • 修复 indexst 变量在自己的索引画廊为第一个时不存在 #1383 (lucyleeow)

项目维护

v0.17.1#

修复的错误

  • FIX: 修复存储的编译正则表达式的稳定性 #1369 (larsoner)

  • ENH: 改善 _sanitize_rst #1366 (timhoffm)

  • 在查找反向引用时遵守 prefer_full_module 设置 #1364 (QuLogic)

  • 修复使用 prefer_full_module 链接到类属性 #1363 (QuLogic)

  • 改进 minigallery 指令路径输入解析 #1360 (lucyleeow)

  • FIX 允许字符串路径 minigallery 条目在反向引用关闭时 #1355 (lucyleeow)

  • FIX 在用户传递索引时生成 zip 文件 #1353 (lucyleeow)

文档

项目维护

v0.17.0#

此版本不再支持 Python 3.8 和 Sphinx 4。现在要求 Python >= 3.9 和 Sphinx >= 5。

实现的增强功能

修复的错误

  • 修复处理多模块 intersphinx 注册表 #1320 (QuLogic)

  • BUG：修复带有 SyntaxError 的跟踪回溯的错误 #1301 (larsoner)

文档

项目维护

v0.16.0#

Sphinx 7.3.0 及以上版本更改了缓存和序列化检查。现在，您应该在 `sphinx_gallery_conf` 中传递完全限定的名称字符串给类或可调用对象，而不是传递实例化的类，如 `ResetArgv()`，类，如 `FileNameSortKey`，或可调用对象，如 `notebook_modification_function`。如果您更改为使用名称字符串，您可以简单地使用函数，因为使用类来确保稳定的 `__repr__` 可能是多余的。

有关详细信息，请参阅 导入可调用对象。

实现的增强功能

  • ENH: 允许使用纯列表作为 `subsection_order` 并支持通配符 #1295 (timhoffm)

  • [ENH] 迷你画廊可以接收任意文件/glob 模式作为输入 #1226 (story645)

修复的错误

文档

项目维护

v0.15.0#

本版本中不再支持 Python 3.7。现在需要 Python >=3.8。Pillow 被添加为依赖项。

实现的增强功能

修复的错误

  • FIX 尽早复制 JupyterLite 内容，使其在 jupyterlite_sphinx 构建完成之前运行 #1213 (lesteve)

  • BUG: 修复了 `sg_api_usage` 孤儿问题 #1207 (larsoner)

  • MAINT 修复了对不匹配的“忽略”块的检查 #1193 (speth)

  • 避免在回溯引用中导入新模块 #1177 (aganders3)

文档

项目维护

v0.14.0#

实现的增强功能

修复的错误

文档

项目维护

v0.13.0#

实现的增强功能

  • ENH: 为默认角色创建反向引用 #1122 (StefRe)

  • ENH 在 check_jupyterlite_conf 中使用未知键时引发错误 #1119 (lesteve)

  • ENH 添加根据 Jupyterlite 笔记本内容修改笔记本的功能 #1113 (lesteve)

  • ENH: 添加对 WebP 的支持 #1111 (StefRe)

修复的错误

API 更改

文档

项目维护

  • 维护：使用非别名 status_iterator #1124 (larsoner)

  • 清理：清理早期配置验证的命名 #1123 (lesteve)

  • 维护：移除 Python 2 遗留代码 #1116 (StefRe)

  • 维护：将最低 Sphinx 版本与 README.rst 同步 #1110 (StefRe)

  • CI：在 CI 中安装 jupyterlite-pyodide-kernel #1107 (lesteve)

  • 添加测试以设置非 agg Matplotlib 后端 #1104 (ayshih)

  • 维护：将版本提升至 dev #1089 (larsoner)

v0.12.2#

修复的错误

v0.12.1#

修复的错误

v0.12.0#

此版本中，对 Sphinx < 4 的支持已移除。最低要求为 Sphinx >= 4。

实现的增强功能

修复的错误

文档

  • 文档：添加关于 html-noplot 的说明，以抑制配置警告。 #1084 (rossbar)

  • 重新排列迷你画廊文档中的段落 #1048 (ayshih)

  • 文档：切换到 pydata-sphinx-theme #1013 (larsoner)

  • 修复 CHANGES 中的 Sphinx 链接拼写错误 #996 (alexisthual)

项目维护

v0.11.1#

此版本中，对 Sphinx < 3 的支持已移除。最低要求为 Sphinx >= 3。

修复的错误

实现的增强功能

v0.11.0#

在此版本中，应用于代码输出的 “Out:” 前缀现在是通过 CSS 伪元素创建的，而不是额外的真实文本。有关更多详细信息，请参阅 #896。

实现的增强功能

嵌套画廊部分（即画廊子文件夹）是在 #904 中实现的。如果想要使用以前的 behavior 可以禁用此功能（参见文档中的配置选项 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

  • 在 load style 中添加 imagesg 指令 #880 (lucyleeow)

  • 在 sphinx_gallery_conf 中使用布尔值表示 “plot_gallery” #863 (timhoffm)

合并的拉取请求

v0.10.0#

在此版本中，默认的 Sphinx-Gallery .css 文件已更新，因此它们的名称都以 ‘sg_’ 开头。有关更多详细信息，请参阅 #845。

实现的增强功能

  • 为非图像泛化 image_scrapers 功能 #833

  • 添加一种模式，只对 rst 警告失败，不运行示例 #751

  • 添加一个 “模板”，以便轻松上手 #555

  • ENH 添加配置，生成虚拟图像以防止丢失图像警告 #828 (lucyleeow)

  • ENH: 在 matplotlib_scraper 和指令中添加 hidpi 选项 #808 (jklymak)

修复的错误

  • BUG URL 在 Binder URL 中引用分支名称和文件路径 #844 (sdhiscocks)

  • 从生成的 reST 中清理 ANSI 字符：从 HTML 输出中删除 ANSI 字符 #838 (agramfort)

  • Bug Pin markupsafe 版本在 Python nightly #831 (lucyleeow)

  • BUG 修复 test_minigallery_directive 在 Windows 上失败 #830 (lucyleeow)

  • BUG 修复 LaTeX 错误：CI 中找不到文件 `tgtermes.sty` #829 (lucyleeow)

合并的拉取请求

v0.9.0#

此版本中不再支持 Python 3.5。要求 Python >=3.6。

实现的增强功能

  • 添加一个模式，如果示例失败，则“跳过”该示例 #789

  • sphinx_gallery_thumbnail_number 是否支持负索引？ #785

  • 配置缩略图样式 #780

  • ENH: 检查无效的 sphinx_gallery_conf 键 #774

  • DOC 文档如何隐藏下载链接说明 #760

  • DOC 在 projects_list.rst 中使用 intersphinx 引用 #755

  • 将输出捕获延迟到下一个代码块 #363

  • ENH: 只有在有东西要显示时才添加 minigallery #813 (NicolasHug)

  • 可选标志，将图形抓取推迟到下一个代码块 #801 (ayshih)

  • ENH: PyQt5 #794 (larsoner)

  • 添加一个配置，在错误时发出警告而不是失败 #792 (Cadair)

  • 让 sphinx_gallery_thumbnail_number 支持负索引 #786 (seisman)

  • 将调整大小到缩略图图像时引入的任何边框设置为透明 #781 (rossbar)

  • MAINT: 将 travis CI 作业移至 Azure #779 (lucyleeow)

  • ENH, DEP: 检查无效的键，删除旧的键 #775 (larsoner)

修复的错误

  • 标题目标上方的空间的自定义 CSS 与 pydata-sphinx-theme 冲突 #815

  • 即使对于没有示例的对象，也会生成 Minigalleries #812

  • Python nightly 由于从 collections.abc 导入 Jinja2 而失败 #790

  • test_rebuild 和 test_error_messages 在 travis 上失败 #777

  • Read the Docs 上不显示动画 #772

  • BUG: 空代码块输出 #765

  • BUG: 修复 CSS 选择器 #816 (larsoner)

  • MAINT: 修复链接测试 #811 (larsoner)

  • 修复 SVG 默认缩略图支持 #810 (jacobolofsson)

  • 澄清自定义 gallery_dirs 的清除文档 #798 (timhoffm)

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

  • BUG 如果最终块为空，则删除 #791 (lucyleeow)

  • 在 README 中将 Travis CI 徽章替换为 Azure 徽章 #783 (sdhiscocks)

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

合并的拉取请求

v0.8.2#

启用在 readthedocs 上渲染 HTML 动画。

实现的增强功能

  • DOC 扩展 sphinx_gallery_thumbnail_path #764 (lucyleeow)

  • ENH: 添加 run_stale_examples 配置变量 #759 (larsoner)

  • 选项禁用示例标题中的说明 #757

  • 添加 show_signature 选项 #756 (jschueller)

  • ENH: 像 jupyter 一样设置 HTML 输出样式 #752 (larsoner)

  • ENH: 添加 reST 注释，只读 #750 (larsoner)

  • 将生成的 rst 文件上的警告和错误关联回源 Python 文件/防止意外写入生成的 文件 #725

修复的错误

  • 示例库已关闭 #753

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

  • DOC 更新 projects_list 中的链接 #754 (lucyleeow)

  • 启用在 readthedocs 上渲染 HTML 动画 #748 (sdhiscocks)

合并的拉取请求

v0.8.1#

修复 Windows 路径的 Binder 徽标图像文件。

修复的错误

  • sphinx_gallery/tests/test_full.py::test_binder_logo_exists 失败（路径明显错误） #746

  • BUG Windows 使用 _static Binder 徽标的相对路径错误 #744

  • BUG 复制 Binder 徽标以避免 Window 驱动器相对路径错误 #745 (lucyleeow)

合并的拉取请求

v0.8.0#

在 0.9.0 版本中，配置 thumbnail_size 的默认值将从 (400, 280)（CSS 指定的最大尺寸的 2.5 倍）更改为 (320, 224)（CSS 指定的最大尺寸的 2 倍）。

实现的增强功能

修复的错误

  • _repr_html_ 未在 RTD 上显示 #736

  • Binder 图标是硬编码的，这会导致某些浏览器上的加载失败 #735

  • 如何在不执行示例脚本的情况下抓取图像 #728

  • sphinx-gallery/0.7.0: TypeError: 'str' object is not callable when building its documentation #727

  • 缩略图过采样 #717

  • 使用预构建的画廊 #704

  • 调用“plt.show()”会引发一个丑陋的警告 #694

  • v0.6.2 稳定版文档中的搜索不起作用 #689

  • 修复日志消息 pypandoc #741 (lucyleeow)

  • 使用本地 binder logo svg #738 (lucyleeow)

  • BUG: 修复对刮板错误的处理 #737 (larsoner)

  • 改进自定义图像刮板示例的文档 #730 (mschmidt87)

  • 使 md5 哈希独立于平台换行符 #722 (sdhiscocks)

  • MAINT: 处理 mayavi #720 (larsoner)

  • DOC 说明 thumbnail_size 并注意默认值的更改 #719 (lucyleeow)

  • BUG: 始终执行链接 #714 (larsoner)

  • DOC: 正确记录选项 #711 (larsoner)

  • BUG 检查“capture_repr”和“ignore_repr_types” #709 (lucyleeow)

  • DOC 更新 Sphinx url #708 (lucyleeow)

  • BUG: 对 zip 下载使用相对路径 #706 (pmeier)

  • FIX: 使用 master 在 nightly 上构建 #703 (larsoner)

  • MAINT: 修复 CircleCI #701 (larsoner)

  • 启用 html 在 readthedocs 上渲染 #700 (sdhiscocks)

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

合并的拉取请求

v0.7.0#

开发人员更改#

  • 使用 Sphinx 错误而不是内置错误。

实现的增强功能

  • ENH: 使用 Sphinx 错误 #690 (larsoner)

  • ENH: 添加对 FuncAnimation 的支持 #687 (larsoner)

  • Sphinx 指令以插入迷你画廊 #685 (ayshih)

  • 提供一个 Sphinx 指令以插入一个迷你画廊 #683

  • ENH 添加交叉引用标签到模板 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

  • 子画廊应该使用单独的“gallery rst”文件生成 #413

  • matplotlib 动画支持 #150

修复的错误

  • 在 module.rst 中添加对类进行反向引用标签 #688 (lucyleeow)

  • 修复反向引用检查以考虑波浪号的使用 #684 (ayshih)

  • 修复测试中的正则表达式以搜索 test_full 中的 numpy RandomState #682 (lucyleeow)

  • 修复测试中的正则表达式以搜索 html 中的 numpy 数据 #681

  • FIX: 修复 sys.stdout 修补 #678 (larsoner)

  • check-manifest 导致 master 失败 #675

  • 如果日志记录器在不同的单元格中创建，则无法捕获日志记录器的输出 #672

  • FIX: 从标题中移除换行符 #669 (larsoner)

  • BUG Tinybuild autosummary 链接在 Sphinx dev 中失败 #659

文档

合并的拉取请求

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)

合并的拉取请求

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

合并的拉取请求

v0.6.0#

开发人员变更#

  • 减少了硬依赖的数量，并添加了 dev-requirements.txt。

  • AppVeyor 从 Python 3.6 升级到 3.7。

  • 拆分 CSS 并创建加载 CSS 的子扩展。

实现的增强功能

修复的错误

合并的拉取请求

v0.5.0#

开发人员变更#

  • 将 ‘dev’ 文档与 master 分开，‘stable’ 文档跟踪发布。

  • 添加了官方 jpeg 支持。

不兼容变更#

  • 不再支持 Sphinx < 1.8.3。

  • 不再支持 Python < 3.5。

  • 添加了 capture_repr 配置，默认设置为 ('_repr_html_', __repr__')。这可能会导致现有项目捕获不必要的输出。将 capture_repr: () 设置为空，以恢复到此版本之前的行为。

实现的增强功能

  • 解释图像抓取器的输入 #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)

修复的错误

合并的拉取请求

v0.4.0#

开发人员变更#

  • 为外部抓取器添加了私有 API 契约，以支持基于字符串的方式，请参阅

  • 现在捕获标准错误并与标准输出一起显示。

  • 现在从图像缩略图工具提示中删除了一些 sphinx 标记。

不兼容变更#

  • v0.4.0 将是最后一个支持 Python <= 3.4 的版本。

  • 展望未来，我们将仅在每次 sphinx-gallery 版本发布时支持最新的两个稳定版 Sphinx 版本。

实现的增强功能

修复的错误

v0.3.1#

Bugfix 版本：添加了缺少的文件，该文件阻止了“pip 安装”包。

修复的错误

  • 版本 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

合并的拉取请求

v0.2.0#

新功能#

  • 添加了通过 binder 配置自动为示例生成 Binder 链接的实验性支持。请注意，此 API 可能在将来发生更改。 #244 和 #371。

  • 添加了 ignore_pattern 可配置选项，允许不将某些 python 文件添加到画廊中。有关更多详细信息，请参阅 #346。

  • 支持在“RGBA”空间中使用自定义默认缩略图 #375

  • 允许仅标题 -> 使用标题作为第一段 #345

错误修复#

  • 修复 name string_replace 在路径中包含“.py”的项目中出现错误。有关更多详细信息，请参阅 #322 和 #331。

  • 修复跨单元格的 __future__ 导入。有关更多详细信息，请参阅 #308。

  • 修复区域设置不是 UTF-8 时的编码相关问题。有关更多详细信息，请参阅 #311。

  • 在详细模式下，示例输出在执行示例期间打印到控制台，而不是仅在结束时打印。有关它重要的用例，请参阅 #301。

  • 修复 sphinx 1.7 中的 SphinxDocLinkResolver 错误。有关更多详细信息，请参阅 #352。

  • 修复 file_pattern 和 expected_failing_examples 之间的意外交互。有关更多详细信息，请参阅 #379 和 #335

  • FIX: 为输出使用无样式的 pygments #384

  • 修复：以“/”结尾的路径的画廊名称 #372

  • 修复标题检测逻辑。 #356

  • FIX: 使用 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#

新功能#

  • 删除 codelinks 工具提示中的样式。替换为由浏览器管理的 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 笔记本 #148

错误修复#

  • 如果 matplotlib 后端无法设置为 'agg'，Sphinx-Gallery 现在会抛出异常。例如，如果在 conf.py 中导入了 matplotlib.pyplot，则可能会发生这种情况。有关更多详细信息，请参见 #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

  • 测试 Sphinx Gallery 在 Ubuntu 14 包上的支持，放弃 Ubuntu 12 支持。在 conda 环境中放弃对 Python 2.6 的支持

v0.1.4#

新功能#

  • 增强了下载按钮的 CSS

  • 画廊末尾的下载按钮，用于将所有 Python 脚本或 Jupyter 笔记本一起下载到一个 zip 文件中。新的配置变量 download_all_examples 用于切换此效果。默认情况下处于激活状态

  • 可下载的 zip 文件，包含所有示例作为 Python 脚本和每个画廊的笔记本

  • 改进了将 rst 指令转换为 Jupyter 笔记本文本块的 markdown

错误修复#

  • 当在示例中导入 seaborn 时，绘图样式偏好会被传递到之后执行的绘图中。CI 设置得可以让用户了解如何在 conda 环境中获得 mayavi-pandas-seaborn 和 nomkl 的兼容版本，以使所有功能都可用。

  • 修复了从示例 rst 到 Jupyter 笔记本文本的数学转换，用于内联数学和多行方程式

v0.1.3#

新功能#

  • 在 sphinx 构建结束时，使用回溯显示失败示例的摘要。默认情况下，如果示例失败，构建会使用 1 退出代码退出。可以在 conf.py 中定义预计会失败的示例列表，并使用 0 退出代码退出构建。或者，也可以在第一个示例失败时就退出构建。

  • 在构建期间，在控制台中打印所有示例的计算时间的聚合和排序列表。

  • 对于创建多个图形的示例，设置缩略图图像。

  • 现在可以在 sphinx_gallery_conf 中指定 plot_gallery 和 abort_on_example_error 选项。构建选项 (-D 传递给 sphinx-build 的标志) 优先于 sphinx_gallery_conf 选项。

错误修复#

  • 失败的示例在每次构建时都会重试

v0.1.2#

错误修复#

  • 使用 if __name__ == '__main__' 保护的示例现在可以运行了

  • 在非笔记本示例的代码输出和代码源之间添加了垂直空间

v0.1.1#

错误修复#

  • 恢复 html-noplot 功能

  • 画廊 CSS 现在隐式地强制执行缩略图宽度

v0.1.0#

亮点#

示例脚本现在可以作为 IPython 笔记本下载 #75

新功能#

  • 可配置的文件名模式，用于在构建画廊时选择要执行的示例脚本

  • 示例脚本更新检查现在通过 md5sum 检查，而不是日期

  • 损坏的示例现在在画廊视图中显示一个损坏的缩略图，在渲染的示例中会打印回溯。用户还可以将构建过程设置为在第一个示例失败时就中止。

  • 按脚本大小排序示例

  • 改进示例样式

v0.0.11#

亮点#

此版本包含使用 PR #36 为画廊添加的笔记本样式示例。

不兼容的更改#

Sphinx-Gallery 将其 Python 模块名称重命名为 sphinx_gallery，这遵循了在 #47 中提出的讨论，并使用 #66 解决。

画廊配置字典也更改了名称，变为 sphinx_gallery_conf

从 PR #36 开始，决定使用新的命名空间约定来命名图像、缩略图和引用。参见 评论

v0.0.10#

亮点#

此版本允许使用反向引用。此功能包含细粒度的示例画廊，这些画廊列出了使用特定函数的示例。 #26

新功能#

  • 将 Sphinx-Gallery 的本地副本放置到项目中的 shell 脚本

  • 在画廊中支持 Mayavi 绘图

在此页面上