Change Log

git master

v0.1.11

Documentation

  • Frequently Asked Questions added to Documentation. Why __file__ is not defined?

Bug Fixed

  • Changed attribute name of Sphinx app object in #242

v0.1.10

Bug Fixed

  • Fix image path handling bug introduced in #218

v0.1.9

Incompatible Changes

  • Sphinx Gallery’s example back-references are deactivated by default. Now it is users responsibility to turn them on and set the directory where to store the files. See discussion in #126 and pull request #151.

Bug Fixed

  • Fix download zip files path in windows builds. See #218
  • Fix embedded missing link. See #214

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

Bug Fixes

  • Sphinx-Gallery build even if examples have Syntax errors. See #177
  • Sphinx-Gallery can now build by directly calling sphinx-build from any path, no explicit need to run the Makefile from the sources directory. See #190 for more details.

v0.1.7

Bug Fixes

  • Released Sphinx 1.5 has new naming convention for auto generated files and breaks Sphinx-Gallery documentation scanner. Fixed in #178, work for linking to documentation generated with Sphinx<1.5 and for new docs post 1.5
  • Code links tooltip are now left aligned with code

New features

  • Development support of Sphinx-Gallery on Windows #179 & #182

v0.1.6

New features

  • Executable script to convert Python scripts into Jupyter Notebooks #148

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 and abort_on_example_error options can now be specified in sphinx_gallery_conf. The build option (-D flag passed to sphinx-build) takes precedence over the sphinx_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

Highlights

Example scripts are now available for download as IPython Notebooks #75

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

Highlights

This release incorporates the Notebook styled examples for the gallery with PR #36

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

v0.0.10

Highlights

This release allows to use the Back references. This features incorporates fine grained examples galleries listing examples using a particular function. #26

New features

  • Shell script to place a local copy of Sphinx-Gallery in your project
  • Support Mayavi plots in the gallery