Sphinx Gallery Versions Save

Sphinx extension for automatic generation of an example gallery

v0.10.0

2 years ago

In this version, the default Sphinx-Gallery .css files have been updated so their names are all prepended with 'sg_'. See #845 for more details.

Implemented enhancements:

  • Generalising image_scrapers facility for non-images #833
  • Add a mode that fails only for rst warnings and does not run examples #751
  • Add a "template", to make it easy to get started #555
  • ENH Add config that generates dummy images to prevent missing image warnings #828 (lucyleeow)
  • ENH: add hidpi option to matplotlib_scraper and directive #808 (jklymak)

Fixed bugs:

  • BUG URL quote branch names and filepaths in Binder URLs #844 (sdhiscocks)
  • Sanitize ANSI characters from generated RST #838 (agramfort)
  • Bug Pin markupsafe version in Python nightly #831 (lucyleeow)
  • BUG Fix test_minigallery_directive failing on Windows #830 (lucyleeow)
  • BUG Fix LaTeX Error: File `tgtermes.sty' not found in CI #829 (lucyleeow)

Closed issues:

  • Galleries using bokeh #841
  • TorchIO now uses sphinx-gallery #823
  • New release #817
  • Change DPI? #804
  • Multiple images in horizontal list are not clickable (cannot zoom in) #429
  • Notebook style issues with indentation #342

Merged pull requests:

v0.9.0

3 years ago

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

Implemented enhancements:

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

Fixed bugs:

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

Closed issues:

  • Generating the output notebooks together with data (folders) used for generating... #809
  • How to link from one example to another? #805
  • Incompatibility with matplotlib 3.4.0 ? #802
  • Pandas _repr_html_ not captured in PDF output #799
  • Optuna project Uses Sphinx-Gallery #795
  • Adding an extended README #771

Merged pull requests:

v0.8.2

3 years ago

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 This release enables HTML animations to be rendered on readthedocs.

Merged pull requests:

v0.8.1

3 years ago

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:

v0.8.0

3 years ago

Future warning: The default for configuration thumbnail_size will change from (400, 280) 5x maximum size specified by CSS) to (320, 224) (2x maximum size specified 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:

v0.7.0

3 years ago

Full Changelog

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:

Closed issues:

  • intersphinx links need backreferences_dir #467

Merged pull requests:

v0.6.2

4 years ago

Full Changelog

Patch release due to missing CSS files in v0.6.1.

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:

v0.6.1

4 years ago

Full Changelog

Note this release is to start Zenodo integration.

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:

Merged pull requests:

v0.6.0

4 years ago

Full Changelog

Implemented enhancements:

Fixed bugs:

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:

v0.5.0

4 years ago

Full Changelog

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:

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: