Sphinx-gallery

-------

Support for Python 3.6 dropped in this release. Requirement is Python >=3.7.

**Implemented enhancements:**

- Feature Request: ``reset_modules`` to be applied after each or all examples `866 <https://github.com/sphinx-gallery/sphinx-gallery/issues/866>`__
- Enable ``reset_modules`` to run either before or after examples, or both `870 <https://github.com/sphinx-gallery/sphinx-gallery/pull/870>`__ (`MatthewFlamm <https://github.com/MatthewFlamm>`__)

**Fixed bugs:**

- embed_code_links throwing <exception: list indices must be integers or slices, not str> `879 <https://github.com/sphinx-gallery/sphinx-gallery/issues/879>`__
- ``0.10.0`` breaks ``sphinx_gallery.load_style`` `878 <https://github.com/sphinx-gallery/sphinx-gallery/issues/878>`__
- Add imagesg directive in load style `880 <https://github.com/sphinx-gallery/sphinx-gallery/pull/880>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Use bools for ‘plot_gallery’ in sphinx_gallery_conf `863 <https://github.com/sphinx-gallery/sphinx-gallery/pull/863>`__ (`timhoffm <https://github.com/timhoffm>`__)

**Merged pull requests:**

- DOC Add reference to sphinx-codeautolink `874 <https://github.com/sphinx-gallery/sphinx-gallery/pull/874>`__ (`felix-hilden <https://github.com/felix-hilden>`__)
- Add Neuraxle to “Who uses Sphinx-Gallery” `873 <https://github.com/sphinx-gallery/sphinx-gallery/pull/873>`__ (`guillaume-chevalier <https://github.com/guillaume-chevalier>`__)
- DOC Fix typo in dummy images doc `871 <https://github.com/sphinx-gallery/sphinx-gallery/pull/871>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- CI: Fix CircleCI `865 <https://github.com/sphinx-gallery/sphinx-gallery/pull/865>`__ (`larsoner <https://github.com/larsoner>`__)

-------

In this version, the default Sphinx-Gallery `.css` files have been
updated so their names are all prepended with 'sg\_'.
For more details see `845 <https://github.com/sphinx-gallery/sphinx-gallery/pull/845#issuecomment-913130302>`_.

**Implemented enhancements:**

- Generalising image_scrapers facility for non-images `833 <https://github.com/sphinx-gallery/sphinx-gallery/issues/833>`__
- Add a mode that fails only for rst warnings and does not run examples `751 <https://github.com/sphinx-gallery/sphinx-gallery/issues/751>`__
- Add a “template”, to make it easy to get started `555 <https://github.com/sphinx-gallery/sphinx-gallery/issues/555>`__
- ENH Add config that generates dummy images to prevent missing image warnings `828 <https://github.com/sphinx-gallery/sphinx-gallery/pull/828>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- ENH: add hidpi option to matplotlib_scraper and directive `808 <https://github.com/sphinx-gallery/sphinx-gallery/pull/808>`__ (`jklymak <https://github.com/jklymak>`__)

**Fixed bugs:**

- BUG URL quote branch names and filepaths in Binder URLs `844 <https://github.com/sphinx-gallery/sphinx-gallery/pull/844>`__ (`sdhiscocks <https://github.com/sdhiscocks>`__)
- Sanitize ANSI characters from generated reST: Remove `ANSI characters <https://en.wikipedia.org/wiki/ANSI_escape_code>`_ from HTML output `#838 <https://github.com/sphinx-gallery/sphinx-gallery/pull/838>`__ (`agramfort <https://github.com/agramfort>`__)
- Bug Pin markupsafe version in Python nightly `831 <https://github.com/sphinx-gallery/sphinx-gallery/pull/831>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- BUG Fix test_minigallery_directive failing on Windows `830 <https://github.com/sphinx-gallery/sphinx-gallery/pull/830>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- BUG Fix LaTeX Error: File \`tgtermes.sty’ not found in CI `829 <https://github.com/sphinx-gallery/sphinx-gallery/pull/829>`__ (`lucyleeow <https://github.com/lucyleeow>`__)

**Merged pull requests:**

- DOC Update reset_modules documentation `861 <https://github.com/sphinx-gallery/sphinx-gallery/pull/861>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Remove trailing whitespace `859 <https://github.com/sphinx-gallery/sphinx-gallery/pull/859>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Add info on enabling animation support to example `858 <https://github.com/sphinx-gallery/sphinx-gallery/pull/858>`__ (`dstansby <https://github.com/dstansby>`__)
- Update css file names, fix documentation `857 <https://github.com/sphinx-gallery/sphinx-gallery/pull/857>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- MAINT: Fix mayavi build hang circleci `850 <https://github.com/sphinx-gallery/sphinx-gallery/pull/850>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- MAINT: Fix mayavi build hang azure CI `848 <https://github.com/sphinx-gallery/sphinx-gallery/pull/848>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Refactor execute_code_block in gen_rst.py `842 <https://github.com/sphinx-gallery/sphinx-gallery/pull/842>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- [Maint] Remove travis `840 <https://github.com/sphinx-gallery/sphinx-gallery/pull/840>`__ (`agramfort <https://github.com/agramfort>`__)
- DOC Add gif to supported image extensions `836 <https://github.com/sphinx-gallery/sphinx-gallery/pull/836>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Clarifications and fixes to image_scrapers doc `834 <https://github.com/sphinx-gallery/sphinx-gallery/pull/834>`__ (`jnothman <https://github.com/jnothman>`__)
- DOC Update projects list in readme.rst `826 <https://github.com/sphinx-gallery/sphinx-gallery/pull/826>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Fix zenodo badge link `825 <https://github.com/sphinx-gallery/sphinx-gallery/pull/825>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Add TorchIO to users list `824 <https://github.com/sphinx-gallery/sphinx-gallery/pull/824>`__ (`fepegar <https://github.com/fepegar>`__)

------

Support for Python 3.5 dropped in this release. Requirement is Python >=3.6.

**Implemented enhancements:**

- Add a mode which “skips” an example if it fails `789 <https://github.com/sphinx-gallery/sphinx-gallery/issues/789>`__
- Can sphinx_gallery_thumbnail_number support negative indexes? `785 <https://github.com/sphinx-gallery/sphinx-gallery/issues/785>`__
- Configure thumbnail style `780 <https://github.com/sphinx-gallery/sphinx-gallery/issues/780>`__
- ENH: Check for invalid sphinx_gallery_conf keys `774 <https://github.com/sphinx-gallery/sphinx-gallery/issues/774>`__
- DOC Document how to hide download link note `760 <https://github.com/sphinx-gallery/sphinx-gallery/issues/760>`__
- DOC use intersphinx references in projects_list.rst `755 <https://github.com/sphinx-gallery/sphinx-gallery/issues/755>`__
- Delay output capturing to a further code block `363 <https://github.com/sphinx-gallery/sphinx-gallery/issues/363>`__
- ENH: Only add minigallery if there’s something to show `813 <https://github.com/sphinx-gallery/sphinx-gallery/pull/813>`__ (`NicolasHug <https://github.com/NicolasHug>`__)
- Optional flag to defer figure scraping to the next code block `801 <https://github.com/sphinx-gallery/sphinx-gallery/pull/801>`__ (`ayshih <https://github.com/ayshih>`__)
- ENH: PyQt5 `794 <https://github.com/sphinx-gallery/sphinx-gallery/pull/794>`__ (`larsoner <https://github.com/larsoner>`__)
- Add a configuration to warn on error not fail `792 <https://github.com/sphinx-gallery/sphinx-gallery/pull/792>`__ (`Cadair <https://github.com/Cadair>`__)
- Let sphinx_gallery_thumbnail_number support negative indexes `786 <https://github.com/sphinx-gallery/sphinx-gallery/pull/786>`__ (`seisman <https://github.com/seisman>`__)
- Make any borders introduced when rescaling images to thumbnails transparent `781 <https://github.com/sphinx-gallery/sphinx-gallery/pull/781>`__ (`rossbar <https://github.com/rossbar>`__)
- MAINT: Move travis CI jobs to Azure `779 <https://github.com/sphinx-gallery/sphinx-gallery/pull/779>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- ENH, DEP: Check for invalid keys, remove ancient key `775 <https://github.com/sphinx-gallery/sphinx-gallery/pull/775>`__ (`larsoner <https://github.com/larsoner>`__)

**Fixed bugs:**

- Custom CSS for space above title target conflicts with pydata-sphinx-theme `815 <https://github.com/sphinx-gallery/sphinx-gallery/issues/815>`__
- Minigalleries are generated even for objects without examples `812 <https://github.com/sphinx-gallery/sphinx-gallery/issues/812>`__
- Python nightly failing due to Jinja2 import from collections.abc `790 <https://github.com/sphinx-gallery/sphinx-gallery/issues/790>`__
- test_rebuild and test_error_messages failing on travis `777 <https://github.com/sphinx-gallery/sphinx-gallery/issues/777>`__
- Animation not show on Read the Docs `772 <https://github.com/sphinx-gallery/sphinx-gallery/issues/772>`__
- BUG: Empty code block output `765 <https://github.com/sphinx-gallery/sphinx-gallery/issues/765>`__
- BUG: Fix CSS selector `816 <https://github.com/sphinx-gallery/sphinx-gallery/pull/816>`__ (`larsoner <https://github.com/larsoner>`__)
- MAINT: Fix test for links `811 <https://github.com/sphinx-gallery/sphinx-gallery/pull/811>`__ (`larsoner <https://github.com/larsoner>`__)
- Fix SVG default thumbnail support `810 <https://github.com/sphinx-gallery/sphinx-gallery/pull/810>`__ (`jacobolofsson <https://github.com/jacobolofsson>`__)
- Clarify clean docs for custom gallery_dirs `798 <https://github.com/sphinx-gallery/sphinx-gallery/pull/798>`__ (`timhoffm <https://github.com/timhoffm>`__)
- MAINT Specify Jinja2 version in azure Python nightly `793 <https://github.com/sphinx-gallery/sphinx-gallery/pull/793>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- BUG Remove if final block empty `791 <https://github.com/sphinx-gallery/sphinx-gallery/pull/791>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Replace Travis CI badge with Azure Badge in README `783 <https://github.com/sphinx-gallery/sphinx-gallery/pull/783>`__ (`sdhiscocks <https://github.com/sdhiscocks>`__)
- Point to up-to-date re documentation `778 <https://github.com/sphinx-gallery/sphinx-gallery/pull/778>`__ (`dstansby <https://github.com/dstansby>`__)

**Merged pull requests:**

- DOC Add section on altering CSS `820 <https://github.com/sphinx-gallery/sphinx-gallery/pull/820>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Use intersphinx references in projects_list.rst `819 <https://github.com/sphinx-gallery/sphinx-gallery/pull/819>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Update CI badge `818 <https://github.com/sphinx-gallery/sphinx-gallery/pull/818>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Include SOURCEDIR in Makefile `814 <https://github.com/sphinx-gallery/sphinx-gallery/pull/814>`__ (`NicolasHug <https://github.com/NicolasHug>`__)
- DOC: add 2 projects using sphinx gallery `807 <https://github.com/sphinx-gallery/sphinx-gallery/pull/807>`__ (`mfeurer <https://github.com/mfeurer>`__)
- DOC: clarify advanced doc wrt referencing examples `806 <https://github.com/sphinx-gallery/sphinx-gallery/pull/806>`__ (`mfeurer <https://github.com/mfeurer>`__)
- MAINT: Add link `800 <https://github.com/sphinx-gallery/sphinx-gallery/pull/800>`__ (`larsoner <https://github.com/larsoner>`__)
- Add Optuna to “Who uses Optuna” `796 <https://github.com/sphinx-gallery/sphinx-gallery/pull/796>`__ (`crcrpar <https://github.com/crcrpar>`__)
- DOC Add segment on CSS styling `788 <https://github.com/sphinx-gallery/sphinx-gallery/pull/788>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC minor doc typo fixes `787 <https://github.com/sphinx-gallery/sphinx-gallery/pull/787>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Update CI links in index.rst `784 <https://github.com/sphinx-gallery/sphinx-gallery/pull/784>`__ (`lucyleeow <https://github.com/lucyleeow>`__)

------

Enables HTML animations to be rendered on readthedocs.

**Implemented enhancements:**

- DOC Expand on sphinx_gallery_thumbnail_path `764 <https://github.com/sphinx-gallery/sphinx-gallery/pull/764>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- ENH: Add run_stale_examples config var `759 <https://github.com/sphinx-gallery/sphinx-gallery/pull/759>`__ (`larsoner <https://github.com/larsoner>`__)
- Option to disable note in example header `757 <https://github.com/sphinx-gallery/sphinx-gallery/issues/757>`__
- Add show_signature option `756 <https://github.com/sphinx-gallery/sphinx-gallery/pull/756>`__ (`jschueller <https://github.com/jschueller>`__)
- ENH: Style HTML output like jupyter `752 <https://github.com/sphinx-gallery/sphinx-gallery/pull/752>`__ (`larsoner <https://github.com/larsoner>`__)
- ENH: Add reST comments, read-only `750 <https://github.com/sphinx-gallery/sphinx-gallery/pull/750>`__ (`larsoner <https://github.com/larsoner>`__)
- Relate warnings and errors on generated rst file back to source Python file / prevent accidental writing of generated files `725 <https://github.com/sphinx-gallery/sphinx-gallery/issues/725>`__

**Fixed bugs:**

- Example gallery is down `753 <https://github.com/sphinx-gallery/sphinx-gallery/issues/753>`__
- DOC Amend run_stale_examples command in configuration.rst `763 <https://github.com/sphinx-gallery/sphinx-gallery/pull/763>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC update link in projects_list `754 <https://github.com/sphinx-gallery/sphinx-gallery/pull/754>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Enable animations HTML to be rendered on readthedocs `748 <https://github.com/sphinx-gallery/sphinx-gallery/pull/748>`__ (`sdhiscocks <https://github.com/sdhiscocks>`__)

**Merged pull requests:**

- FIX: Restore whitespace `768 <https://github.com/sphinx-gallery/sphinx-gallery/pull/768>`__ (`larsoner <https://github.com/larsoner>`__)
- CI: Remove AppVeyor, work on Azure `767 <https://github.com/sphinx-gallery/sphinx-gallery/pull/767>`__ (`larsoner <https://github.com/larsoner>`__)
- DOC Standardise capitalisation of Sphinx-Gallery `762 <https://github.com/sphinx-gallery/sphinx-gallery/pull/762>`__ (`lucyleeow <https://github.com/lucyleeow>`__)

------

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 <https://github.com/sphinx-gallery/sphinx-gallery/issues/746>`__
- BUG Windows relative path error with \_static Binder logo `744 <https://github.com/sphinx-gallery/sphinx-gallery/issues/744>`__
- BUG Copy Binder logo to avoid Window drive rel path error `745 <https://github.com/sphinx-gallery/sphinx-gallery/pull/745>`__ (`lucyleeow <https://github.com/lucyleeow>`__)

**Merged pull requests:**

- DOC Add link to cross referencing example `743 <https://github.com/sphinx-gallery/sphinx-gallery/pull/743>`__ (`lucyleeow <https://github.com/lucyleeow>`__)

------

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 <https://github.com/sphinx-gallery/sphinx-gallery/issues/731>`__
- Limited rst to md support in notebooks `219 <https://github.com/sphinx-gallery/sphinx-gallery/issues/219>`__
- Enable ffmpeg for animations for newer matplotlib `733 <https://github.com/sphinx-gallery/sphinx-gallery/pull/733>`__ (`dopplershift <https://github.com/dopplershift>`__)
- Implement option to pass command line args to example scripts `732 <https://github.com/sphinx-gallery/sphinx-gallery/pull/732>`__ (`mschmidt87 <https://github.com/mschmidt87>`__)
- ENH: Dont allow input `729 <https://github.com/sphinx-gallery/sphinx-gallery/pull/729>`__ (`larsoner <https://github.com/larsoner>`__)
- Add support for image links and data URIs for notebooks `724 <https://github.com/sphinx-gallery/sphinx-gallery/pull/724>`__ (`sdhiscocks <https://github.com/sdhiscocks>`__)
- Support headings in reST to MD `723 <https://github.com/sphinx-gallery/sphinx-gallery/pull/723>`__ (`sdhiscocks <https://github.com/sdhiscocks>`__)
- ENH Support pypandoc to convert rst to md for ipynb `705 <https://github.com/sphinx-gallery/sphinx-gallery/pull/705>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- ENH: Use broader def of Animation `693 <https://github.com/sphinx-gallery/sphinx-gallery/pull/693>`__ (`larsoner <https://github.com/larsoner>`__)

**Fixed bugs:**

- \_repr_html\_ not shown on RTD `736 <https://github.com/sphinx-gallery/sphinx-gallery/issues/736>`__
- Binder icon is hardcoded, which causes a loading failure with on some browsers `735 <https://github.com/sphinx-gallery/sphinx-gallery/issues/735>`__
- How to scrape for images without executing example scripts `728 <https://github.com/sphinx-gallery/sphinx-gallery/issues/728>`__
- sphinx-gallery/0.7.0: TypeError: ‘str’ object is not callable when building its documentation `727 <https://github.com/sphinx-gallery/sphinx-gallery/issues/727>`__
- Thumbnail oversampling `717 <https://github.com/sphinx-gallery/sphinx-gallery/issues/717>`__
- Working with pre-built galleries `704 <https://github.com/sphinx-gallery/sphinx-gallery/issues/704>`__
- Calling “plt.show()” raises an ugly warning `694 <https://github.com/sphinx-gallery/sphinx-gallery/issues/694>`__
- Searching in docs v0.6.2 stable does not work `689 <https://github.com/sphinx-gallery/sphinx-gallery/issues/689>`__
- Fix logger message pypandoc `741 <https://github.com/sphinx-gallery/sphinx-gallery/pull/741>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Use local binder logo svg `738 <https://github.com/sphinx-gallery/sphinx-gallery/pull/738>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- BUG: Fix handling of scraper error `737 <https://github.com/sphinx-gallery/sphinx-gallery/pull/737>`__ (`larsoner <https://github.com/larsoner>`__)
- Improve documentation of example for custom image scraper `730 <https://github.com/sphinx-gallery/sphinx-gallery/pull/730>`__ (`mschmidt87 <https://github.com/mschmidt87>`__)
- Make md5 hash independent of platform line endings `722 <https://github.com/sphinx-gallery/sphinx-gallery/pull/722>`__ (`sdhiscocks <https://github.com/sdhiscocks>`__)
- MAINT: Deal with mayavi `720 <https://github.com/sphinx-gallery/sphinx-gallery/pull/720>`__ (`larsoner <https://github.com/larsoner>`__)
- DOC Clarify thumbnail_size and note change in default `719 <https://github.com/sphinx-gallery/sphinx-gallery/pull/719>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- BUG: Always do linking `714 <https://github.com/sphinx-gallery/sphinx-gallery/pull/714>`__ (`larsoner <https://github.com/larsoner>`__)
- DOC: Correctly document option `711 <https://github.com/sphinx-gallery/sphinx-gallery/pull/711>`__ (`larsoner <https://github.com/larsoner>`__)
- BUG Check ‘capture_repr’ and ‘ignore_repr_types’ `709 <https://github.com/sphinx-gallery/sphinx-gallery/pull/709>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Update Sphinx url `708 <https://github.com/sphinx-gallery/sphinx-gallery/pull/708>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- BUG: Use relative paths for zip downloads `706 <https://github.com/sphinx-gallery/sphinx-gallery/pull/706>`__ (`pmeier <https://github.com/pmeier>`__)
- FIX: Build on nightly using master `703 <https://github.com/sphinx-gallery/sphinx-gallery/pull/703>`__ (`larsoner <https://github.com/larsoner>`__)
- MAINT: Fix CircleCI `701 <https://github.com/sphinx-gallery/sphinx-gallery/pull/701>`__ (`larsoner <https://github.com/larsoner>`__)
- Enable html to be rendered on readthedocs `700 <https://github.com/sphinx-gallery/sphinx-gallery/pull/700>`__ (`sdhiscocks <https://github.com/sdhiscocks>`__)
- Remove matplotlib agg warning `696 <https://github.com/sphinx-gallery/sphinx-gallery/pull/696>`__ (`lucyleeow <https://github.com/lucyleeow>`__)

**Merged pull requests:**

- DOC add section on interpreting error/warnings `740 <https://github.com/sphinx-gallery/sphinx-gallery/pull/740>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Add citation details to readme `739 <https://github.com/sphinx-gallery/sphinx-gallery/pull/739>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Plotly example for the gallery `718 <https://github.com/sphinx-gallery/sphinx-gallery/pull/718>`__ (`emmanuelle <https://github.com/emmanuelle>`__)
- DOC Specify matplotlib in animation example `716 <https://github.com/sphinx-gallery/sphinx-gallery/pull/716>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- MAINT: Bump pytest versions in Travis runs `712 <https://github.com/sphinx-gallery/sphinx-gallery/pull/712>`__ (`larsoner <https://github.com/larsoner>`__)
- DOC Update warning section in configuration.rst `702 <https://github.com/sphinx-gallery/sphinx-gallery/pull/702>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC remove mention of other builder types `698 <https://github.com/sphinx-gallery/sphinx-gallery/pull/698>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Bumpversion `692 <https://github.com/sphinx-gallery/sphinx-gallery/pull/692>`__ (`lucyleeow <https://github.com/lucyleeow>`__)