Change Log¶
git master¶
v0.2.0¶
New features¶
- Added experimental support to auto-generate Binder links for examples via
binder
config. Note that this API may change in the future. #244 and #371. - Added
ignore_pattern
configurable to allow not adding some python files into the gallery. See #346 for more details. - Support for custom default thumbnails in ‘RGBA’ space #375
- Allow title only -> use title as first paragraph #345
Bug Fixes¶
- Fix name string_replace trips on projects with “.py” in path. See #322 and #331 for more details.
- Fix __future__ imports across cells. See #308 for more details.
- Fix encoding related issues when locale is not UTF-8. See #311 for more details.
- In verbose mode, example output is printed to the console during execution of the example, rather than only at the end. See #301 for a use case where it matters.
- Fix SphinxDocLinkResolver error with sphinx 1.7. See #352 for more details.
- Fix unexpected interaction between
file_pattern
andexpected_failing_examples
. See #379 and #335 - FIX: Use unstyled pygments for output #384
- Fix: Gallery name for paths ending with ‘/’ #372
- Fix title detection logic. #356
- FIX: Use
docutils_namespace
to avoid warning in sphinx 1.8dev #387
Incompatible Changes¶
v0.1.13¶
New features¶
- Added
min_reported_time
configurable. For examples that run faster than that threshold (in seconds), the execution time is not reported. - Add thumbnail_size option #283
- Use intersphinx for all function reference resolution #296
- Sphinx only directive for downloads #298
- Allow sorting subsection files #281
- We recommend using a string for
plot_gallery
rather than Python booleans, e.g.'True'
instead ofTrue
, as it avoids a warning about unicode when controlling this value via the command line switches ofsphinx-build
Bug Fixes¶
v0.1.11¶
Documentation¶
- Frequently Asked Questions added to Documentation. Why __file__ is not defined?
v0.1.9¶
Incompatible Changes¶
Bug Fixed¶
Developer changes¶
- Move testing to py.test
- Include link to github repository in documentation
v0.1.8¶
New features¶
- Drop styling in codelinks tooltip. Replaced for title attribute which is managed by the browser.
- Gallery output is shorter when embedding links
- Circle CI testing
v0.1.7¶
v0.1.6¶
Bug Fixes¶
- Sphinx-Gallery now raises an exception if the matplotlib bakend can
not be set to
'agg'
. This can happen for example if matplotlib.pyplot is imported in conf.py. See #157 for more details. - Fix
backreferences.identify_names
when module is used without attribute #173. Closes #172 and #149 - Raise FileNotFoundError when README.txt is not present in the main directory of the examples gallery(#164). Also include extra empty lines after reading README.txt to obtain the correct rendering of the html file.(#165)
- Ship a License file in PyPI release
v0.1.5¶
New features¶
- CSS. Now a tooltip is displayed on the source code blocks to make the doc-resolv functionality more discorverable. Function calls in the source code blocks are hyperlinks to their online documentation.
- Download buttons have a nicer look across all themes offered by Sphinx
Developer changes¶
Support on the fly theme change for local builds of the Sphinx-Gallery docs. Passing to the make target the variable theme builds the docs with the new theme. All sphinx themes are available plus read the docs online theme under the value rtd as shown in this usage example.:
$ make html theme=rtd
Test Sphinx Gallery support on Ubuntu 14 packages, drop Ubuntu 12 support. Drop support for Python 2.6 in the conda environment
v0.1.4¶
New features¶
- Enhanced CSS for download buttons
- Download buttons at the end of the gallery to download all python scripts or Jupyter notebooks together in a zip file. New config variable download_all_examples to toggle this effect. Activated by default
- Downloadable zip file with all examples as Python scripts and notebooks for each gallery
- Improved conversion of rst directives to markdown for the Jupyter notebook text blocks
Bug Fixes¶
- When seaborn is imported in a example the plot style preferences are transferred to plots executed afterwards. The CI is set up such that users can follow how to get the compatible versions of mayavi-pandas-seaborn and nomkl in a conda environment to have all the features available.
- Fix math conversion from example rst to Jupyter notebook text for inline math and multi-line equations
v0.1.3¶
New features¶
- Summary of failing examples with traceback at the end of the sphinx build. By default the build exits with a 1 exit code if an example has failed. A list of examples that are expected to fail can be defined in conf.py and exit the build with 0 exit code. Alternatively it is possible to exit the build as soon as one example has failed.
- Print aggregated and sorted list of computation times of all examples in the console during the build.
- For examples that create multiple figures, set the thumbnail image.
- The
plot_gallery
andabort_on_example_error
options can now be specified insphinx_gallery_conf
. The build option (-D
flag passed tosphinx-build
) takes precedence over thesphinx_gallery_conf
option.
Bug Fixes¶
- Failing examples are retried on every build
v0.1.2¶
Bug Fixes¶
- Examples that use
if __name__ == '__main__'
guards are now run - Added vertical space between code output and code source in non notebook examples
v0.1.1¶
Bug Fixes¶
- Restore the html-noplot functionality
- Gallery CSS now implicitly enforces thumbnails width
v0.1.0¶
New features¶
- Configurable filename pattern to select which example scripts are executed while building the Gallery
- Examples script update check are now by md5sum check and not date
- Broken Examples now display a Broken thumbnail in the gallery view, inside the rendered example traceback is printed. User can also set build process to abort as soon as an example fails.
- Sorting examples by script size
- Improve examples style
v0.0.11¶
Incompatible Changes¶
Sphinx-Gallery renames its python module name to sphinx_gallery this follows the discussion raised in #47 and resolved with #66
The gallery configuration dictionary also changes its name to sphinx_gallery_conf
From PR #36 it is decided into a new namespace convention for images, thumbnails and references. See comment