Sphinx-gallery

-------

Documentation
'''''''''''''''

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

Bug Fixed
'''''''''

* Changed attribute name of Sphinx `app` object in `242
<https://github.com/sphinx-gallery/sphinx-gallery/issues/242>`_

-------

Bug Fixed
'''''''''

* Fix image path handling bug introduced in 218

------

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
<https://github.com/sphinx-gallery/sphinx-gallery/issues/126>`_ and
pull request `151
<https://github.com/sphinx-gallery/sphinx-gallery/issues/151>`_.

Bug Fixed
'''''''''

* Fix download zip files path in windows builds. See `218 <https://github.com/sphinx-gallery/sphinx-gallery/pull/218>`_
* Fix embedded missing link. See `214 <https://github.com/sphinx-gallery/sphinx-gallery/pull/214>`_

Developer changes
'''''''''''''''''

* Move testing to py.test
* Include link to github repository in documentation

------

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 <https://github.com/sphinx-gallery/sphinx-gallery/pull/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 <https://github.com/sphinx-gallery/sphinx-gallery/pull/190>`_
for more details.

------

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