# Change Log

## v0.8.2

Enables HTML animations to be rendered on readthedocs.

Implemented enhancements:

- DOC Expand on sphinx_gallery_thumbnail_path #764 (lucyleeow)

- ENH: Add run_stale_examples config var #759 (larsoner)

- Option to disable note in example header #757

- Add show_signature option #756 (jschueller)

- ENH: Style HTML output like jupyter #752 (larsoner)

- ENH: Add RST comments, read-only #750 (larsoner)

- Relate warnings and errors on generated rst file back to source Python file / prevent accidental writing of generated files #725

Fixed bugs:

- Example gallery is down #753

- DOC Amend run_stale_examples command in configuration.rst #763 (lucyleeow)

- DOC update link in projects_list #754 (lucyleeow)

- Enable animations HTML to be rendered on readthedocs #748 (sdhiscocks)

Closed issues:

- MNT: Stop using ci-helpers in appveyor.yml #766

Merged pull requests:

- FIX: Restore whitespace #768 (larsoner)

- CI: Remove AppVeyor, work on Azure #767 (larsoner)

- DOC Standardise capitalisation of Sphinx-Gallery #762 (lucyleeow)

## v0.8.1

Fix Binder logo image file for Windows paths.

Fixed bugs:

- sphinx_gallery/tests/test_full.py::test_binder_logo_exists fails (path is clearly wrong) #746

- BUG Windows relative path error with _static Binder logo #744

- BUG Copy Binder logo to avoid Window drive rel path error #745 (lucyleeow)

Merged pull requests:

- DOC Add link to cross referencing example #743 (lucyleeow)

## v0.8.0

The default for configuration thumbnail_size will change from (400, 280) (2.5x maximum size specified by CSS) to (320, 224) (2x maximum size specified by CSS) in version 0.9.0.

Implemented enhancements:

- Pass command line arguments to examples #731

- Limited rst to md support in notebooks #219

- Enable ffmpeg for animations for newer matplotlib #733 (dopplershift)

- Implement option to pass command line args to example scripts #732 (mschmidt87)

- ENH: Dont allow input #729 (larsoner)

- Add support for image links and data URIs for notebooks #724 (sdhiscocks)

- Support headings in RST to MD #723 (sdhiscocks)

- ENH Support pypandoc to convert rst to md for ipynb #705 (lucyleeow)

- ENH: Use broader def of Animation #693 (larsoner)

Fixed bugs:

- _repr_html_ not shown on RTD #736

- Binder icon is hardcoded, which causes a loading failure with on some browsers #735

- How to scrape for images without executing example scripts #728

- sphinx-gallery/0.7.0: TypeError: ‘str’ object is not callable when building its documentation #727

- Thumbnail oversampling #717

- Working with pre-built galleries #704

- Calling “plt.show()” raises an ugly warning #694

- Searching in docs v0.6.2 stable does not work #689

- Fix logger message pypandoc #741 (lucyleeow)

- Use local binder logo svg #738 (lucyleeow)

- BUG: Fix handling of scraper error #737 (larsoner)

- Improve documentation of example for custom image scraper #730 (mschmidt87)

- Make md5 hash independent of platform line endings #722 (sdhiscocks)

- MAINT: Deal with mayavi #720 (larsoner)

- DOC Clarify thumbnail_size and note change in default #719 (lucyleeow)

- BUG: Always do linking #714 (larsoner)

- DOC: Correctly document option #711 (larsoner)

- BUG Check ‘capture_repr’ and ‘ignore_repr_types’ #709 (lucyleeow)

- DOC Update Sphinx url #708 (lucyleeow)

- BUG: Use relative paths for zip downloads #706 (pmeier)

- FIX: Build on nightly using master #703 (larsoner)

- MAINT: Fix CircleCI #701 (larsoner)

- Enable html to be rendered on readthedocs #700 (sdhiscocks)

- Remove matplotlib agg warning #696 (lucyleeow)

Closed issues:

- Reference :ref:`sphx\_glr\_auto\_examples` goes to SciKit-Learn examples #734

- Q: how to have a couple of images with `bbox\_inches='tight'`. #726

- filename_pattern still doesn’t work all that great for working on one tutorial #721

- Gallery example using plotly #715

- DOC Builder types clarification #697

Merged pull requests:

- DOC add section on interpreting error/warnings #740 (lucyleeow)

- DOC Add citation details to readme #739 (lucyleeow)

- Plotly example for the gallery #718 (emmanuelle)

- DOC Specify matplotlib in animation example #716 (lucyleeow)

- MAINT: Bump pytest versions in Travis runs #712 (larsoner)

- DOC Update warning section in configuration.rst #702 (lucyleeow)

- DOC remove mention of other builder types #698 (lucyleeow)

- Bumpversion #692 (lucyleeow)

## v0.7.0

### Developer changes

- Use Sphinx errors rather than built-in errors.

Implemented enhancements:

- ENH: Use Sphinx errors #690 (larsoner)

- ENH: Add support for FuncAnimation #687 (larsoner)

- Sphinx directive to insert mini-galleries #685 (ayshih)

- Provide a Sphinx directive to insert a mini-gallery #683

- ENH Add cross ref label to template module.rst #680 (lucyleeow)

- ENH: Add show_memory extension API #677 (larsoner)

- Support for GPU memory logging #671

- ENH Add alt attribute for thumbnails #668 (lucyleeow)

- ENH More informative ‘alt’ attribute for thumbnails in index #664

- ENH More informative ‘alt’ attribute for images #663 (lucyleeow)

- ENH: Use optipng when requested #656 (larsoner)

- thumbnails cause heavy gallery pages and long loading time #655

- MAINT: Better error messages #600

- More informative “alt” attribute for image tags #538

- ENH: easy linking to “examples using my_function” #496

- sub-galleries should be generated with a separate “gallery rst” file #413

- matplotlib animations support #150

Fixed bugs:

- Add backref label for classes in module.rst #688 (lucyleeow)

- Fixed backreference inspection to account for tilde use #684 (ayshih)

- Fix regex for numpy RandomState in test_full #682 (lucyleeow)

- fix tests regex to search for numpy data in html #681

- FIX: Fix sys.stdout patching #678 (larsoner)

- check-manifest causing master to fail #675

- Output of logger is not captured if the logger is created in a different cell #672

- FIX: Remove newlines from title #669 (larsoner)

- BUG Tinybuild autosummary links fail with Sphinx dev #659

Documentation:

- DOC Update label to raw string in plot_0_sin.py #674 (lucyleeow)

- DOC Update Sphinx url to https #673 (lucyleeow)

- DOC Clarify syntax.rst #670 (lucyleeow)

- DOC Note config comment removal in code only #667 (lucyleeow)

- DOC Update links in syntax.rst #666 (lucyleeow)

- DOC Fix typos, clarify #662 (lucyleeow)

- DOC Update html-noplot #658 (lucyleeow)

- DOC: Fix PNGScraper example #653 (denkii)

- DOC: Fix typos in documentation files. #652 (TomDonoghue)

- Inconsistency with applying & removing sphinx gallery configs #665

- `make html-noplot` instructions outdated #606

Closed issues:

- intersphinx links need backreferences_dir #467

Merged pull requests:

- Fix lint in gen_gallery.py #686 (lucyleeow)

- Better alt thumbnail test for punctuation in title #679 (lucyleeow)

- Update manifest for changes to check-manifest #676 (lucyleeow)

- MAINT: Update CircleCI #657 (larsoner)

- Bump version to 0.7.0.dev0 #651 (lucyleeow)

## v0.6.2

- Patch release due to missing CSS files in v0.6.1. Manifest check added to CI.

Implemented enhancements:

- How do I best cite sphinx-gallery? #639

- MRG, ENH: Add Zenodo badge #641 (larsoner)

Fixed bugs:

- BUG Wrong pandas intersphinx URL #646

- css not included in wheels? #644

- BUG: Fix CSS includes and add manifest check in CI #648 (larsoner)

- Update pandas intersphinx url #647 (lucyleeow)

Merged pull requests:

- Update maintainers url in RELEASES.md #649 (lucyleeow)

- DOC Amend maintainers #643 (lucyleeow)

- Change version back to 0.7.0.dev0 #642 (lucyleeow)

## v0.6.1

### Developer changes

- Added Zenodo integration. This release is for Zenodo to pick it up.

Implemented enhancements:

- Allow pathlib.Path to backreferences_dir option #635

- ENH Allow backrefences_dir to be pathlib object #638 (lucyleeow)

Fixed bugs:

- TypeError when creating links from gallery to documentation #634

- BUG Checks if filenames have space #636 (lucyleeow)

- Fix missing space in error message. #632 (anntzer)

- BUG: Spaces in example filenames break image linking #440

Closed issues:

- New release? #627

Merged pull requests:

- DOC minor update to release guide #633 (lucyleeow)

- Bump release version #631 (lucyleeow)

## v0.6.0

### Developer changes

- Reduced number of hard dependencies and added dev-requirements.txt.

- AppVeyor bumped from Python 3.6 to 3.7.

- Split CSS and create sub-extension that loads CSS.

Implemented enhancements:

- ENH Add last cell config #625 (lucyleeow)

- ENH: Add sub-classes for download links #623 (larsoner)

- ENH: New file-based conf-parameter thumbnail_path #609 (prisae)

- MRG, ENH: Provide sub-extension sphinx_gallery.load_style #601 (mgeier)

- [DOC] Minor amendments to CSS config part #594 (lucyleeow)

- [MRG] [ENH] Add css for pandas df #590 (lucyleeow)

- ENH: Add CSS classes for backrefs #581 (larsoner)

- Add ability to ignore repr of specific types #577 (banesullivan)

Fixed bugs:

- BUG: Longer timeout on macOS #629 (larsoner)

- BUG Fix test for new sphinx #619 (lucyleeow)

- MRG, FIX: Allow pickling #604 (larsoner)

- CSS: Restrict thumbnail height to 112 px #595 (mgeier)

- MRG, FIX: Link to RandomState properly #593 (larsoner)

- MRG, FIX: Fix backref styling #591 (larsoner)

- MAINT: Update checks for PIL/JPEG #586 (larsoner)

- DOC: Fix code block language #585 (larsoner)

- [MRG] Fix backreferences for functions not directly imported #584 (lucyleeow)

- BUG: Fix repr None #578 (larsoner)

- [MRG] Add ignore pattern to check dups #574 (lucyleeow)

- [MRG] Check backreferences_dir config #571 (lucyleeow)

- URLError #569 (EtienneCmb)

- MRG Remove last/first_notebook_cell redundancy #626 (lucyleeow)

- Remove duplicate doc_solver entry in the API reference structure #589 (kanderso-nrel)

Closed issues:

- Allow removal of “download jupyter notebook” link #622

- thumbnails from loaded figures #607

- last_notebook_cell #605

- Building fails with pickling error #602

- BUG: Bugs with backref links #587

- BUG backreferences not working for functions if not imported directly #583

- AttributeError: ‘URLError’ object has no attribute ‘url’ #568

- BUG Check “backreferences_dir” is str or None #567

- check_duplicated does not respect the ignore_pattern #474

- Sphinx-Gallery Binder links: environment.yml does not get “installed” #628

- Another place to replace “######” separators by “# %%” #620

- How to prevent output to stderr from being captured. #618

- Master failing with sphinx dev #617

- Mention the support for _repr_html_ on custom scraper doc #614

- Mention the multiple possible separators in the notebook-style example #611

- Cell marker causes pycodestyle error #608

- Reduce the amount of hard dependencies? #597

- instances not getting correct CSS classes #588

- greedy backreferences #580

- Error when using two image scrappers together #579

- Improve the junit xml #576

- Remove the note linking to the download section at the beginning of the example from latex/pdf output #572

- typing.TYPE_CHECKING is True at runtime in executed .py files #570

- How best to handle data files? #565

- ENH Add CSS for pandas dataframe #544

Merged pull requests:

- DOC use # %% #624 (lucyleeow)

- DOC capture repr in scraper section #616 (lucyleeow)

- [MRG+1] DOC Improve doc of splitters and use in IDE #615 (lucyleeow)

- DOC mention template #613 (lucyleeow)

- recommend consistent use of one block splitter #610 (mikofski)

- MRG, MAINT: Split CSS and add control #599 (larsoner)

- MRG, MAINT: Update deps #598 (larsoner)

- MRG, ENH: Link to methods and properties properly #596 (larsoner)

- MAINT: Try to get nightly working #592 (larsoner)

- mention literalinclude in the doc #582 (emmanuelle)

- MAINT: Bump AppVeyor to 3.7 #575 (larsoner)

## v0.5.0

### Developer changes

- Separated ‘dev’ documentation, which tracks master and ‘stable’ documentation, which follows releases.

- Added official jpeg support.

### Incompatible changes

- Dropped support for Sphinx < 1.8.3.

- Dropped support for Python < 3.5.

- Added `capture_repr` configuration with the default setting `('_repr_html_', __repr__')`. This may result the capturing of unwanted output in existing projects. Set `capture_repr: ()` to return to behaviour prior to this release.

Implemented enhancements:

- Explain the inputs of the image scrapers #472

- Capture HTML output as in Jupyter #396

- Feature request: Add an option for different cell separations #370

- Mark sphinx extension as parallel-safe for writing #561 (astrofrog)

- ENH: Support linking to builtin modules #558 (larsoner)

- ENH: Add official JPG support and better tests #557 (larsoner)

- [MRG] ENH: Capture ’repr’s of last expression #541 (lucyleeow)

- look for both ‘README’ and ‘readme’ #535 (revesansparole)

- ENH: Speed up builds #526 (larsoner)

- ENH: Add live object refs and methods #525 (larsoner)

- ENH: Show memory usage, too #523 (larsoner)

- [MRG] EHN support #%% cell separators #518 (lucyleeow)

- MAINT: Remove support for old Python and Sphinx #513 (larsoner)

Fixed bugs:

- Documentation is ahead of current release #559

- Fix JPEG thumbnail generation #556 (rgov)

- [MRG] Fix terminal rst block last word #548 (lucyleeow)

- [MRG][FIX] Remove output box from print(__doc__) #529 (lucyleeow)

- BUG: Fix kwargs modification in loop #527 (larsoner)

- MAINT: Fix AppVeyor #524 (larsoner)

Closed issues:

- Making sphinx-gallery parallel_write_safe #560

- Mayavi example cannot run in binder #554

- Support pyqtgraph plots #553

- Last word in rst used as code #546

- ENH capture ’repr’s of last expression #540

- Mention list of projects using sphinx-gallery in a documentation page #536

- consider looking also for ‘readme.*’ instead of only ‘README.*’ #534

- Small regression in 0.4.1: print(__doc__) creates empty output block #528

- Show memory usage in build output #522

- Linking to external examples #519

- Intro text gets truncated on ‘-’ character #517

- REL: New release #507

- Matplotlib raises warning when ‘pyplot.show()’ is called #488

- Only support the latest 2 or 3 Sphinx versions #407

- Drop Python 2.X support #405

- Inspiration from new gallery package for sphinx: sphinx-exhibit #402

- DOC: each example should start by explaining why it’s there #143

Merged pull requests:

- [MRG] DOC: Add warning filter note in doc #564 (lucyleeow)

- [MRG] DOC: Explain each example #563 (lucyleeow)

- ENH: Add dev/stable distinction #562 (larsoner)

- DOC update example capture_repr #552 (lucyleeow)

- BUG: Fix index check #551 (larsoner)

- FIX: Fix spurious failures #550 (larsoner)

- MAINT: Update CIs #549 (larsoner)

- list of projects using sphinx-gallery #547 (emmanuelle)

- [MRG] DOC typos and clarifications #545 (lucyleeow)

- add class to clear tag #543 (dorafc)

- MAINT: Fix for 3.8 #542 (larsoner)

- [MRG] DOC: Explain image scraper inputs #539 (lucyleeow)

- [MRG] Allow punctuation marks in title #537 (lucyleeow)

- Improve documentation #533 (lucyleeow)

- ENH: Add direct link to artifact #532 (larsoner)

- [MRG] Remove matplotlib agg backend + plt.show warnings from doc #521 (lesteve)

- MAINT: Fixes for latest pytest #516 (larsoner)

- Add FURY to the sphinx-gallery users list #515 (skoudoro)

## v0.4.0

### Developer changes

- Added a private API contract for external scrapers to have string-based support, see:

  > https://github.com/sphinx-gallery/sphinx-gallery/pull/494

- Standard error is now caught and displayed alongside standard output.

- Some sphinx markup is now removed from image thumbnail tooltips.

### Incompatible changes

- v0.4.0 will be the last release to support Python <= 3.4.

- Moving forward, we will support only the latest two stable Sphinx releases at the time of each sphinx-gallery release.

Implemented enhancements:

- ENH: Remove some Sphinx markup from text #511 (larsoner)

- ENH: Allow README.rst ext #510 (larsoner)

- binder requirements with Dockerfile? #476

- ENH: Update docs #509 (larsoner)

- Add documentation note on RTD-Binder incompatibility #505 (StanczakDominik)

- Add PlasmaPy to list of sphinx-gallery users #504 (StanczakDominik)

- ENH: Expose example globals #502 (larsoner)

- DOC: Update docs #501 (larsoner)

- add link to view sourcecode in docs #499 (sappelhoff)

- MRG, ENH: Catch and write warnings #495 (larsoner)

- MRG, ENH: Add private API for external scrapers #494 (larsoner)

- Add list of external image scrapers #492 (banesullivan)

- Add more examples of projects using sphinx-gallery #489 (banesullivan)

- Add option to remove sphinx_gallery config comments #487 (timhoffm)

- FIX: allow Dockerfile #477 (jasmainak)

- MRG: Add SVG support #471 (larsoner)

- MAINT: Simplify CircleCI build #462 (larsoner)

- Release v0.3.0 #456 (choldgraf)

- adding contributing guide for releases #455 (choldgraf)

Fixed bugs:

- fix wrong keyword in docs for “binder” #500 (sappelhoff)

- Fix ‘Out:’ label position in html output block #484 (timhoffm)

- Mention pytest-coverage dependency #482 (timhoffm)

- Fix ReST block after docstring #480 (timhoffm)

- MAINT: Tolerate Windows mtime #478 (larsoner)

- FIX: Output from code execution is not stripped #475 (padix-key)

- FIX: Link #470 (larsoner)

- FIX: Minor fixes for memory profiling #468 (larsoner)

- Add output figure numbering breaking change in release notes. #466 (lesteve)

- Remove links to read the docs #461 (GaelVaroquaux)

- [MRG+1] Add requirements.txt to manifest #458 (ksunden)

Closed issues:

- Allow .rst extension for README files #508

- Generation of unchanged examples #506

- Binder integration and Read the docs #503

- Extending figure_rst to support html figures? #498

- ENH: remove API crossrefs from hover text #497

- BUG: warnings/stderr not captured #491

- Should `image\_scrapers` be renamed (to `output\_scrapers` for example)? #485

- Strip in-file sphinx_gallery directives from code #481

- Generating gallery sometimes freezes #479

- Adding a ReST block immediately after the module docstring breaks the generated .rst file #473

- how to make custom image scraper #469

- pythonhosted.org seems to be still up and running #465

- Small regression in 0.3.1 with output figure numbering #464

- Change output format of images #463

- Version 0.3.0 release is broken on pypi #459

- sphinx-gallery doesn’t play nice with sphinx’s ability to detect new files… #449

- Remove the readthedocs version of sphinx gallery docs #444

- Support for Plotly #441

- Release v0.3.0 #406

- Unnecessary regeneration of example pages #395

- Unnecessary regeneration of API docs #394

## v0.3.1

Bugfix release: add missing file that prevented “pip installing” the package.

Fixed bugs:

- Version 0.3.0 release is broken on pypi #459

## v0.3.0

### Incompatible changes

- the output figure numbering is always 1, 2, …, `number_of_figures` whereas in 0.2.0 it would follow the matplotlib figure numbers. If you include explicitly some figures generated by sphinx-gallery with the `.. figure` directive in your `.rst` documentation you may need to adjust their paths if your example uses non-default matplotlib figure numbers (e.g. if you use `plt.figure(0)`). See #464 <https://github.com/sphinx-gallery/sphinx-gallery/issues/464> for more details.

### Developer changes

- Dropped support for Sphinx <= 1.4.

- Refactor for independent rst file construction. Function `sphinx_gallery.gen_rst.generate_file_rst` does not anymore compose the rst file while it is executing each block of the source code. Currently executing the example script `execute_script` is an independent function and returns structured in a list the rst representation of the output of each source block. `generate_file_rst` calls for execution of the script when needed, then from the rst output it composes an rst document which includes the prose, code & output of the example which is the directly saved to file including the annotations of binder badges, download buttons and timing statistics.

- Binder link config changes. The configuration value for the BinderHub has been changed from `url` to `binderhub_url` in order to make it more explicit. The old configuration key (`url`) will be deprecated in version v0.4.0)

- Support for generating JUnit XML summary files via the `'junit'` configuration value, which can be useful for building on CI services such as CircleCI. See the related CircleCI doc and blog post.

Fixed bugs:

- First gallery plot uses .matplotlibrc rather than the matplotlib defaults #316

Closed issues:

- SG not respecting highlight_lang in conf.py #452

- sphinx-gallery doesn’t play nice with sphinx’s ability to detect new files… #449

- gallery generation broken on cpython master #442

- Improve binder button instructions #438

- Won’t display stdout #435

- realtive paths in github.io #434

- ‘make html’ does not attempt to run examples #425

- Sprint tomorrow @ euroscipy? #412

- Release v0.3.0 #409

- Supported Python and Sphinx versions #404

- How to get the `.css` files to copy over on building the docs? #399

- feature request: only rebuild individual examples #397

- Unnecessary regeneration of example pages #395

- Unnecessary regeneration of API docs #394

- matplotlib inline vs notebook #388

- Can this work for files other than .py ? #378

- v0.1.14 release plan #344

- SG misses classes that aren’t imported #205

- Add a page showing the time taken by the examples #203

- Lack of `install\_requires` #192

Merged pull requests:

- [MRG+1]: Output JUnit XML file #454 (larsoner)

- MRG: Use highlight_language #453 (larsoner)

- BUG: Fix execution time writing #451 (larsoner)

- MRG: Adjust lineno for 3.8 #450 (larsoner)

- MRG: Only rebuild necessary parts #448 (larsoner)

- MAINT: Drop 3.4, add mayavi to one #447 (larsoner)

- MAINT: Modernize requirements #445 (larsoner)

- Activating travis on pre-release of python #443 (NelleV)

- [MRG] updating binder instructions #439 (choldgraf)

- FIX: Fix for latest sphinx-dev #437 (larsoner)

- adding notes for filename #436 (choldgraf)

- FIX: correct sorting docstring for the FileNameSortKey class #433 (mrakitin)

- MRG: Fix for latest pytest #432 (larsoner)

- FIX: Bump version #431 (larsoner)

- MRG: Fix for newer sphinx #430 (larsoner)

- DOC: Missing perenthisis in PNGScraper #428 (ksunden)

- Fix #425 #426 (Titan-C)

- Scraper documentation and an image file path scraper #417 (choldgraf)

- MRG: Remove outdated cron job #416 (larsoner)

- ENH: Profile memory #415 (larsoner)

- fix typo #414 (zasdfgbnm)

- FIX: Travis #410 (larsoner)

- documentation index page and getting_started updates #403 (choldgraf)

- adding ability to customize first cell of notebooks #401 (choldgraf)

- spelling fix #398 (amueller)

- [MRG] Fix Circle v2 #393 (lesteve)

- MRG: Move to CircleCI V2 #392 (larsoner)

- MRG: Fix for 1.8.0 dev #391 (larsoner)

- Drop “Total running time” when generating the documentation #390 (lamby)

- Add dedicated class for timing related block #359 (ThomasG77)

- MRG: Add timing information #348 (larsoner)

- MRG: Add refs from docstring to backrefs #347 (larsoner)

- API: Refactor image scraping #313 (larsoner)

- [MRG] FIX import local modules in examples #305 (NelleV)

- [MRG] Separate rst notebook generation from execution of the script #239 (Titan-C)

## 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` and `expected_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

- Removed optipng feature that was triggered when the `SKLEARN_DOC_OPTIPNG` variable was set. See #349 for more details.

- `Backreferences_dir` is now mandatory #307

### Developer changes

- Dropped support for Sphinx <= 1.4.

- Add SphinxAppWrapper class in `test_gen_gallery.py` #386

- Notes on how to do a release #360

- Add codecov support #328

## 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 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

- Fix gzip/BytesIO error #293

- Deactivate virtualenv provided by Travis #294

### Developer changes

- Push the docs from Circle CI into github #268

- Report version to sphinx. #292

- Minor changes to log format. #285 and #291

## v0.1.12

### New features

- Implement a explicit order sortkey to specify the subsection’s order within a gallery. Refer to discussion in #37, #233 and #234

- Cleanup console output during build #250

- New configuration Test #225

### Bug Fixes

- Reset `sys.argv` before running each example. See #252 for more details.

- Correctly re-raise errors in doc resolver. See #264.

- Allow and use https links where possible #258.

- Escape tooltips for any HTML special characters. #249

### Documentation

- Update link to numpy to point to latest #271

- Added documentation dependencies. #267

## 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