Sphinx-gallery

-------

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 <https://github.com/sphinx-gallery/sphinx-gallery/pull/283>`_
* Use intersphinx for all function reference resolution `296 <https://github.com/sphinx-gallery/sphinx-gallery/pull/296>`_
* Sphinx only directive for downloads `298 <https://github.com/sphinx-gallery/sphinx-gallery/pull/298>`_
* Allow sorting subsection files `281 <https://github.com/sphinx-gallery/sphinx-gallery/pull/281>`_
* We recommend using a string for ``plot_gallery`` rather than Python booleans, e.g. ``'True'`` instead
of ``True``, as it avoids a warning about unicode when controlling this value via the command line
switches of ``sphinx-build``

Bug Fixes
'''''''''

* Crasher in doc_resolv, in js_index.loads `287 <https://github.com/sphinx-gallery/sphinx-gallery/issues/287>`_
* Fix gzip/BytesIO error `293 <https://github.com/sphinx-gallery/sphinx-gallery/pull/293>`_
* Deactivate virtualenv provided by Travis `294 <https://github.com/sphinx-gallery/sphinx-gallery/pull/294>`_

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

* Push the docs from Circle CI into github `268 <https://github.com/sphinx-gallery/sphinx-gallery/pull/268>`_
* Report version to sphinx. `292 <https://github.com/sphinx-gallery/sphinx-gallery/pull/292>`_
* Minor changes to log format. `285 <https://github.com/sphinx-gallery/sphinx-gallery/pull/285>`_ and `#291 <https://github.com/sphinx-gallery/sphinx-gallery/pull/291>`_

-------

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

* Implement a explicit order sortkey to specify the subsection's order
within a gallery. Refer to discussion in
`37 <https://github.com/sphinx-gallery/sphinx-gallery/issues/37>`_,
`233 <https://github.com/sphinx-gallery/sphinx-gallery/pull/233>`_ and
`234 <https://github.com/sphinx-gallery/sphinx-gallery/pull/234>`_
* Cleanup console output during build
`250 <https://github.com/sphinx-gallery/sphinx-gallery/pull/250>`_
* New configuration Test
`225 <https://github.com/sphinx-gallery/sphinx-gallery/pull/225>`_

Bug Fixes
'''''''''

* Reset ``sys.argv`` before running each example. See
`252 <https://github.com/sphinx-gallery/sphinx-gallery/pull/252>`_
for more details.
* Correctly re-raise errors in doc resolver. See
`264 <https://github.com/sphinx-gallery/sphinx-gallery/pull/264>`_.
* Allow and use https links where possible
`258 <https://github.com/sphinx-gallery/sphinx-gallery/pull/258>`_.
* Escape tooltips for any HTML special characters.
`249 <https://github.com/sphinx-gallery/sphinx-gallery/pull/249>`_

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

* Update link to numpy to point to latest
`271 <https://github.com/sphinx-gallery/sphinx-gallery/pull/271>`_
* Added documentation dependencies.
`267 <https://github.com/sphinx-gallery/sphinx-gallery/pull/267>`_

-------

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.