Sphinx-gallery

------

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>`__)

------

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

- Use Sphinx errors rather than built-in errors.

**Implemented enhancements:**

- ENH: Use Sphinx errors `690 <https://github.com/sphinx-gallery/sphinx-gallery/pull/690>`__ (`larsoner <https://github.com/larsoner>`__)
- ENH: Add support for FuncAnimation `687 <https://github.com/sphinx-gallery/sphinx-gallery/pull/687>`__ (`larsoner <https://github.com/larsoner>`__)
- Sphinx directive to insert mini-galleries `685 <https://github.com/sphinx-gallery/sphinx-gallery/pull/685>`__ (`ayshih <https://github.com/ayshih>`__)
- Provide a Sphinx directive to insert a mini-gallery `683 <https://github.com/sphinx-gallery/sphinx-gallery/issues/683>`__
- ENH Add cross ref label to template module.rst `680 <https://github.com/sphinx-gallery/sphinx-gallery/pull/680>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- ENH: Add show_memory extension API `677 <https://github.com/sphinx-gallery/sphinx-gallery/pull/677>`__ (`larsoner <https://github.com/larsoner>`__)
- Support for GPU memory logging `671 <https://github.com/sphinx-gallery/sphinx-gallery/issues/671>`__
- ENH Add alt attribute for thumbnails `668 <https://github.com/sphinx-gallery/sphinx-gallery/pull/668>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- ENH More informative ‘alt’ attribute for thumbnails in index `664 <https://github.com/sphinx-gallery/sphinx-gallery/issues/664>`__
- ENH More informative ‘alt’ attribute for images `663 <https://github.com/sphinx-gallery/sphinx-gallery/pull/663>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- ENH: Use optipng when requested `656 <https://github.com/sphinx-gallery/sphinx-gallery/pull/656>`__ (`larsoner <https://github.com/larsoner>`__)
- thumbnails cause heavy gallery pages and long loading time `655 <https://github.com/sphinx-gallery/sphinx-gallery/issues/655>`__
- MAINT: Better error messages `600 <https://github.com/sphinx-gallery/sphinx-gallery/issues/600>`__
- More informative “alt” attribute for image tags `538 <https://github.com/sphinx-gallery/sphinx-gallery/issues/538>`__
- ENH: easy linking to “examples using my_function” `496 <https://github.com/sphinx-gallery/sphinx-gallery/issues/496>`__
- sub-galleries should be generated with a separate “gallery rst” file `413 <https://github.com/sphinx-gallery/sphinx-gallery/issues/413>`__
- matplotlib animations support `150 <https://github.com/sphinx-gallery/sphinx-gallery/issues/150>`__

**Fixed bugs:**

- Add backref label for classes in module.rst `688 <https://github.com/sphinx-gallery/sphinx-gallery/pull/688>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Fixed backreference inspection to account for tilde use `684 <https://github.com/sphinx-gallery/sphinx-gallery/pull/684>`__ (`ayshih <https://github.com/ayshih>`__)
- Fix regex for numpy RandomState in test_full `682 <https://github.com/sphinx-gallery/sphinx-gallery/pull/682>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- fix tests regex to search for numpy data in html `681 <https://github.com/sphinx-gallery/sphinx-gallery/issues/681>`__
- FIX: Fix sys.stdout patching `678 <https://github.com/sphinx-gallery/sphinx-gallery/pull/678>`__ (`larsoner <https://github.com/larsoner>`__)
- check-manifest causing master to fail `675 <https://github.com/sphinx-gallery/sphinx-gallery/issues/675>`__
- Output of logger is not captured if the logger is created in a different cell `672 <https://github.com/sphinx-gallery/sphinx-gallery/issues/672>`__
- FIX: Remove newlines from title `669 <https://github.com/sphinx-gallery/sphinx-gallery/pull/669>`__ (`larsoner <https://github.com/larsoner>`__)
- BUG Tinybuild autosummary links fail with Sphinx dev `659 <https://github.com/sphinx-gallery/sphinx-gallery/issues/659>`__

**Documentation:**

- DOC Update label to raw string in plot_0_sin.py `674 <https://github.com/sphinx-gallery/sphinx-gallery/pull/674>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Update Sphinx url to https `673 <https://github.com/sphinx-gallery/sphinx-gallery/pull/673>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Clarify syntax.rst `670 <https://github.com/sphinx-gallery/sphinx-gallery/pull/670>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Note config comment removal in code only `667 <https://github.com/sphinx-gallery/sphinx-gallery/pull/667>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Update links in syntax.rst `666 <https://github.com/sphinx-gallery/sphinx-gallery/pull/666>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Fix typos, clarify `662 <https://github.com/sphinx-gallery/sphinx-gallery/pull/662>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Update html-noplot `658 <https://github.com/sphinx-gallery/sphinx-gallery/pull/658>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC: Fix PNGScraper example `653 <https://github.com/sphinx-gallery/sphinx-gallery/pull/653>`__ (`denkii <https://github.com/denkii>`__)
- DOC: Fix typos in documentation files. `652 <https://github.com/sphinx-gallery/sphinx-gallery/pull/652>`__ (`TomDonoghue <https://github.com/TomDonoghue>`__)
- Inconsistency with applying & removing sphinx gallery configs `665 <https://github.com/sphinx-gallery/sphinx-gallery/issues/665>`__
- ``make html-noplot`` instructions outdated `606 <https://github.com/sphinx-gallery/sphinx-gallery/issues/606>`__

**Merged pull requests:**

- Fix lint in gen_gallery.py `686 <https://github.com/sphinx-gallery/sphinx-gallery/pull/686>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Better alt thumbnail test for punctuation in title `679 <https://github.com/sphinx-gallery/sphinx-gallery/pull/679>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Update manifest for changes to check-manifest `676 <https://github.com/sphinx-gallery/sphinx-gallery/pull/676>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- MAINT: Update CircleCI `657 <https://github.com/sphinx-gallery/sphinx-gallery/pull/657>`__ (`larsoner <https://github.com/larsoner>`__)
- Bump version to 0.7.0.dev0 `651 <https://github.com/sphinx-gallery/sphinx-gallery/pull/651>`__ (`lucyleeow <https://github.com/lucyleeow>`__)

------

- 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 <https://github.com/sphinx-gallery/sphinx-gallery/issues/639>`__
- MRG, ENH: Add Zenodo badge `641 <https://github.com/sphinx-gallery/sphinx-gallery/pull/641>`__ (`larsoner <https://github.com/larsoner>`__)

**Fixed bugs:**

- BUG Wrong pandas intersphinx URL `646 <https://github.com/sphinx-gallery/sphinx-gallery/issues/646>`__
- css not included in wheels? `644 <https://github.com/sphinx-gallery/sphinx-gallery/issues/644>`__
- BUG: Fix CSS includes and add manifest check in CI `648 <https://github.com/sphinx-gallery/sphinx-gallery/pull/648>`__ (`larsoner <https://github.com/larsoner>`__)
- Update pandas intersphinx url `647 <https://github.com/sphinx-gallery/sphinx-gallery/pull/647>`__ (`lucyleeow <https://github.com/lucyleeow>`__)

**Merged pull requests:**

- Update maintainers url in RELEASES.md `649 <https://github.com/sphinx-gallery/sphinx-gallery/pull/649>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- DOC Amend maintainers `643 <https://github.com/sphinx-gallery/sphinx-gallery/pull/643>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Change version back to 0.7.0.dev0 `642 <https://github.com/sphinx-gallery/sphinx-gallery/pull/642>`__ (`lucyleeow <https://github.com/lucyleeow>`__)

------

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

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

**Implemented enhancements:**

- Allow pathlib.Path to backreferences_dir option `635 <https://github.com/sphinx-gallery/sphinx-gallery/issues/635>`__
- ENH Allow backrefences_dir to be pathlib object `638 <https://github.com/sphinx-gallery/sphinx-gallery/pull/638>`__ (`lucyleeow <https://github.com/lucyleeow>`__)

**Fixed bugs:**

- TypeError when creating links from gallery to documentation `634 <https://github.com/sphinx-gallery/sphinx-gallery/issues/634>`__
- BUG Checks if filenames have space `636 <https://github.com/sphinx-gallery/sphinx-gallery/pull/636>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Fix missing space in error message. `632 <https://github.com/sphinx-gallery/sphinx-gallery/pull/632>`__ (`anntzer <https://github.com/anntzer>`__)
- BUG: Spaces in example filenames break image linking `440 <https://github.com/sphinx-gallery/sphinx-gallery/issues/440>`__

**Merged pull requests:**

- DOC minor update to release guide `633 <https://github.com/sphinx-gallery/sphinx-gallery/pull/633>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
- Bump release version `631 <https://github.com/sphinx-gallery/sphinx-gallery/pull/631>`__ (`lucyleeow <https://github.com/lucyleeow>`__)