Sphinx-gallery

------

Bug Fixes
'''''''''

* Released Sphinx 1.5 has new naming convention for auto generated
files and breaks Sphinx-Gallery documentation scanner. Fixed in
`178 <https://github.com/sphinx-gallery/sphinx-gallery/pull/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
<https://github.com/sphinx-gallery/sphinx-gallery/pull/179>`_ & `#182
<https://github.com/sphinx-gallery/sphinx-gallery/pull/182>`_

----------

New features
''''''''''''

* Executable script to convert Python scripts into Jupyter Notebooks `148 <https://github.com/sphinx-gallery/sphinx-gallery/pull/148>`_


Bug Fixes
'''''''''
* Sphinx-Gallery now raises an exception if the matplotlib backend can
not be set to ``'agg'``. This can happen for example if
matplotlib.pyplot is imported in conf.py. See `157
<https://github.com/sphinx-gallery/sphinx-gallery/pull/157>`_ for
more details.
* Fix ``backreferences.identify_names`` when module is used without
attribute `173
<https://github.com/sphinx-gallery/sphinx-gallery/pull/173>`_. Closes
`172 <https://github.com/sphinx-gallery/sphinx-gallery/issues/172>`_
and `149
<https://github.com/sphinx-gallery/sphinx-gallery/issues/149>`_
* Raise FileNotFoundError when README.txt is not present in the main
directory of the examples gallery(`164
<https://github.com/sphinx-gallery/sphinx-gallery/pull/164>`_). Also
include extra empty lines after reading README.txt to obtain the
correct rendering of the html file.(`165
<https://github.com/sphinx-gallery/sphinx-gallery/pull/165>`_)
* Ship a License file in PyPI release

------

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.

.. code-block:: console

$ 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

------

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

------

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

------

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