Skip to content

Update sphinx_gallery to 0.11.0#430

Closed
pyup-bot wants to merge 1 commit intomainfrom
pyup-update-sphinx_gallery-0.9.0-to-0.11.0
Closed

Update sphinx_gallery to 0.11.0#430
pyup-bot wants to merge 1 commit intomainfrom
pyup-update-sphinx_gallery-0.9.0-to-0.11.0

Conversation

@pyup-bot
Copy link
Copy Markdown
Collaborator

This PR updates sphinx_gallery from 0.9.0 to 0.11.0.

Changelog

0.11.0

-------

In this version, the "Out:" prefix applied to code outputs is now created from
CSS pseudo-elements instead of additional real text. For more details, see
`896 <https://github.com/sphinx-gallery/sphinx-gallery/pull/896>`__.

**Implemented enhancements:**

Nesting gallery sections (i.e. gallery subfolders) was implemented in`904 <https://github.com/sphinx-gallery/sphinx-gallery/pull/904>`__. This feature can be disabled (see config option ``nested_sections`` in the documentation) if the previous behaviour is prefered (`alexisthual <https://github.com/alexisthual>`__)

Tooltips now overlay gallery items `commit 36166cd <https://github.com/sphinx-gallery/sphinx-gallery/pull/944/commits/36166cd2fc2b43ecbd585654cfe8745f3a1b3f64>`__. Custom CSS might need to be adapted (`alexisthual <https://github.com/alexisthual>`__).

-  Problem in section and example title level in subgalleries `935 <https://github.com/sphinx-gallery/sphinx-gallery/issues/935>`__
-  Add ability to write nested ``index.rst`` `855 <https://github.com/sphinx-gallery/sphinx-gallery/issues/855>`__
-  Optional usage of ``module`` instead of ``module_short`` when doing backreferencing `950 <https://github.com/sphinx-gallery/sphinx-gallery/pull/950>`__ (`ExtremOPS <https://github.com/ExtremOPS>`__)
-  ENH: Better dark mode support `948 <https://github.com/sphinx-gallery/sphinx-gallery/pull/948>`__ (`larsoner <https://github.com/larsoner>`__)
-  Store API reference examples thumbnails in common div `946 <https://github.com/sphinx-gallery/sphinx-gallery/pull/946>`__ (`alexisthual <https://github.com/alexisthual>`__)
-  Add flag to ignore code blocks in Python source parser `941 <https://github.com/sphinx-gallery/sphinx-gallery/pull/941>`__ (`guberti <https://github.com/guberti>`__)
-  Improve Jupyter notebook converter’s handling of code blocks `940 <https://github.com/sphinx-gallery/sphinx-gallery/pull/940>`__ (`guberti <https://github.com/guberti>`__)
-  [MRG] Changelog regarding nested sections `926 <https://github.com/sphinx-gallery/sphinx-gallery/pull/926>`__ (`alexisthual <https://github.com/alexisthual>`__)
-  Possibility to exclude implicit backreferences `908 <https://github.com/sphinx-gallery/sphinx-gallery/pull/908>`__ (`StefRe <https://github.com/StefRe>`__)
-  [MRG] Handle nested structures `904 <https://github.com/sphinx-gallery/sphinx-gallery/pull/904>`__ (`alexisthual <https://github.com/alexisthual>`__)
-  Use pseudo-elements for ‘Out:’ prefixing `896 <https://github.com/sphinx-gallery/sphinx-gallery/pull/896>`__ (`QuLogic <https://github.com/QuLogic>`__)
-  FIX: Fix for latest pytest `894 <https://github.com/sphinx-gallery/sphinx-gallery/pull/894>`__ (`larsoner <https://github.com/larsoner>`__)
-  Config capture_repr on file-by-file basis `891 <https://github.com/sphinx-gallery/sphinx-gallery/pull/891>`__ (`StefRe <https://github.com/StefRe>`__)

**Fixed bugs:**

We now display gallery items using CSS grid instead of  ``float`` property `906 <https://github.com/sphinx-gallery/sphinx-gallery/pull/906>`__, see `migration guide <https://github.com/sphinx-gallery/sphinx-gallery/pull/906#issuecomment-1019542067>`__ to adapt custom CSS for thumbnails (`alexisthual <https://github.com/alexisthual>`__)

-  BUG: Hotfix for docopts_url `980 <https://github.com/sphinx-gallery/sphinx-gallery/pull/980>`__ (`larsoner <https://github.com/larsoner>`__)
-  BUG: Fix bug with clicking examples `973 <https://github.com/sphinx-gallery/sphinx-gallery/pull/973>`__ (`larsoner <https://github.com/larsoner>`__)
-  Remove test examples for seaborn warning `971 <https://github.com/sphinx-gallery/sphinx-gallery/pull/971>`__ (`lesteve <https://github.com/lesteve>`__)
-  Fix typo `970 <https://github.com/sphinx-gallery/sphinx-gallery/pull/970>`__ (`tkoyama010 <https://github.com/tkoyama010>`__)
-  Avoid matplotlib warnings in seaborn reset_module `969 <https://github.com/sphinx-gallery/sphinx-gallery/pull/969>`__ (`lesteve <https://github.com/lesteve>`__)
-  Fix Tensorflow/Abseil compatibility `961 <https://github.com/sphinx-gallery/sphinx-gallery/pull/961>`__ (`guberti <https://github.com/guberti>`__)
-  syntax error fix in sphinx_gallery.downloads `951 <https://github.com/sphinx-gallery/sphinx-gallery/pull/951>`__ (`photoniker <https://github.com/photoniker>`__)
-  Merge toctrees containing subcategories indices and examples without … `944 <https://github.com/sphinx-gallery/sphinx-gallery/pull/944>`__ (`alexisthual <https://github.com/alexisthual>`__)
-  Fix rendering of embedded URIs in Python notebooks `943 <https://github.com/sphinx-gallery/sphinx-gallery/pull/943>`__ (`guberti <https://github.com/guberti>`__)
-  FIX: Fix for dep `938 <https://github.com/sphinx-gallery/sphinx-gallery/pull/938>`__ (`larsoner <https://github.com/larsoner>`__)
-  Fix typos `934 <https://github.com/sphinx-gallery/sphinx-gallery/pull/934>`__ (`kianmeng <https://github.com/kianmeng>`__)
-  MAINT: Fix CIs `932 <https://github.com/sphinx-gallery/sphinx-gallery/pull/932>`__ (`larsoner <https://github.com/larsoner>`__)
-  MAINT: Use -nWT –keep-going on Azure `924 <https://github.com/sphinx-gallery/sphinx-gallery/pull/924>`__ (`larsoner <https://github.com/larsoner>`__)
-  Ensures right builder conifg `922 <https://github.com/sphinx-gallery/sphinx-gallery/pull/922>`__ (`ExtremOPS <https://github.com/ExtremOPS>`__)
-  MAINT: Fix CIs `920 <https://github.com/sphinx-gallery/sphinx-gallery/pull/920>`__ (`larsoner <https://github.com/larsoner>`__)
-  MAINT: Clean up namespace `917 <https://github.com/sphinx-gallery/sphinx-gallery/pull/917>`__ (`larsoner <https://github.com/larsoner>`__)
-  FIX: Azure `915 <https://github.com/sphinx-gallery/sphinx-gallery/pull/915>`__ (`larsoner <https://github.com/larsoner>`__)
-  [WIP] Bugfix missing parent div for mini gallery `914 <https://github.com/sphinx-gallery/sphinx-gallery/pull/914>`__ (`alexisthual <https://github.com/alexisthual>`__)
-  Honor show_signature `909 <https://github.com/sphinx-gallery/sphinx-gallery/pull/909>`__ (`jschueller <https://github.com/jschueller>`__)
-  Css grid for thumbnails `906 <https://github.com/sphinx-gallery/sphinx-gallery/pull/906>`__ (`alexisthual <https://github.com/alexisthual>`__)
-  Fix matplotlib intersphinx url `902 <https://github.com/sphinx-gallery/sphinx-gallery/pull/902>`__ (`StefRe <https://github.com/StefRe>`__)
-  FIX: Pin pyvista `901 <https://github.com/sphinx-gallery/sphinx-gallery/pull/901>`__ (`larsoner <https://github.com/larsoner>`__)
-  Fix matplotlib resetter \_reset_matplotlib `890 <https://github.com/sphinx-gallery/sphinx-gallery/pull/890>`__ (`StefRe <https://github.com/StefRe>`__)
-  Fix “Out” layout for pydata-sphinx-theme `886 <https://github.com/sphinx-gallery/sphinx-gallery/pull/886>`__ (`timhoffm <https://github.com/timhoffm>`__)

**Documentation updates**

-  added RADIS in Who uses Sphinx-gallery ? `979 <https://github.com/sphinx-gallery/sphinx-gallery/pull/979>`__ (`erwanp <https://github.com/erwanp>`__)
-  add Tonic to list of sphinx-gallery users `972 <https://github.com/sphinx-gallery/sphinx-gallery/pull/972>`__ (`biphasic <https://github.com/biphasic>`__)
-  Add Apache TVM to user projects list `942 <https://github.com/sphinx-gallery/sphinx-gallery/pull/942>`__ (`guberti <https://github.com/guberti>`__)
-  DOC: fix rst link syntax in changelog `925 <https://github.com/sphinx-gallery/sphinx-gallery/pull/925>`__ (`GaelVaroquaux <https://github.com/GaelVaroquaux>`__)
-  add GitHub URL for PyPi `923 <https://github.com/sphinx-gallery/sphinx-gallery/pull/923>`__ (`andriyor <https://github.com/andriyor>`__)
-  Add Biotite to list of user projects `919 <https://github.com/sphinx-gallery/sphinx-gallery/pull/919>`__ (`padix-key <https://github.com/padix-key>`__)
-  MAINT: Remove LooseVersion `916 <https://github.com/sphinx-gallery/sphinx-gallery/pull/916>`__ (`larsoner <https://github.com/larsoner>`__)
-  DOC Fix example “Identifying function names in a script” `903 <https://github.com/sphinx-gallery/sphinx-gallery/pull/903>`__ (`StefRe <https://github.com/StefRe>`__)
-  DOC Update docs for Adding mini-galleries for API documentation `899 <https://github.com/sphinx-gallery/sphinx-gallery/pull/899>`__ (`StefRe <https://github.com/StefRe>`__)
-  Add PyVista examples! `888 <https://github.com/sphinx-gallery/sphinx-gallery/pull/888>`__ (`banesullivan <https://github.com/banesullivan>`__)
-  Fix a few links in project lists `883 <https://github.com/sphinx-gallery/sphinx-gallery/pull/883>`__ (`ixjlyons <https://github.com/ixjlyons>`__)

**Closed issues:**

-  Matplotlib warnings in seaborn example: “Trying to register the cmap which already exists” `968 <https://github.com/sphinx-gallery/sphinx-gallery/issues/968>`__
-  reference_url failure in sphinx version > 5 `967 <https://github.com/sphinx-gallery/sphinx-gallery/issues/967>`__
-  Send feedback `963 <https://github.com/sphinx-gallery/sphinx-gallery/issues/963>`__
-  disable download buttons `949 <https://github.com/sphinx-gallery/sphinx-gallery/issues/949>`__
-  Specify Target of ``reference_url`` `947 <https://github.com/sphinx-gallery/sphinx-gallery/issues/947>`__
-  Display bug for examples mentioning a given API reference `945 <https://github.com/sphinx-gallery/sphinx-gallery/issues/945>`__
-  Subfolder Examples appearing in main TOC `939 <https://github.com/sphinx-gallery/sphinx-gallery/issues/939>`__
-  Sphinx-gallery generating huge rst files `929 <https://github.com/sphinx-gallery/sphinx-gallery/issues/929>`__
-  Broken plot links if sphinx uses ``htmldir`` `921 <https://github.com/sphinx-gallery/sphinx-gallery/issues/921>`__
-  Distorted gallery overview `918 <https://github.com/sphinx-gallery/sphinx-gallery/issues/918>`__
-  mini-gallery not shown in grid `911 <https://github.com/sphinx-gallery/sphinx-gallery/issues/911>`__
-  0.10.1: pep517 build warnings `907 <https://github.com/sphinx-gallery/sphinx-gallery/issues/907>`__
-  Make thumbnails grid- and flexbox-compatible `905 <https://github.com/sphinx-gallery/sphinx-gallery/issues/905>`__
-  DOC: Example “Identifying function names in a script” `900 <https://github.com/sphinx-gallery/sphinx-gallery/issues/900>`__
-  Limit adding mini-galleries for API docs to explicitly referred to items only `898 <https://github.com/sphinx-gallery/sphinx-gallery/issues/898>`__
-  Documentation “Add mini-galleries for API documentation” `897 <https://github.com/sphinx-gallery/sphinx-gallery/issues/897>`__
-  TestLoggingTee failing pytest v7.0.0rc1 `893 <https://github.com/sphinx-gallery/sphinx-gallery/issues/893>`__
-  Resetting matplotlib module `889 <https://github.com/sphinx-gallery/sphinx-gallery/issues/889>`__
-  Thumbnail for non plot examples `887 <https://github.com/sphinx-gallery/sphinx-gallery/issues/887>`__
-  Looking for backrefrences “..examples” files instead of “.examples” files `885 <https://github.com/sphinx-gallery/sphinx-gallery/issues/885>`__
-  Build gallery from .ipynb files only `882 <https://github.com/sphinx-gallery/sphinx-gallery/issues/882>`__
-  Examples showing at the top instead of interlaced in-between every class `876 <https://github.com/sphinx-gallery/sphinx-gallery/issues/876>`__
-  Creating API mini-gallery using autosummary recursive option `797 <https://github.com/sphinx-gallery/sphinx-gallery/issues/797>`__

**Merged pull requests:**

0.10.1

-------

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

**Closed issues:**

-  Idea: make galleries out of the “testing” folder to use each unit test as an example. `875 <https://github.com/sphinx-gallery/sphinx-gallery/issues/875>`__
-  Output text in dark mode is not visible `869 <https://github.com/sphinx-gallery/sphinx-gallery/issues/869>`__
-  Using a .gif image works in ``.rst`` sphinx build but not inside example generated with sphinx-gallery `868 <https://github.com/sphinx-gallery/sphinx-gallery/issues/868>`__
-  How to avoid capture of tqdm progress bars `867 <https://github.com/sphinx-gallery/sphinx-gallery/issues/867>`__

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

0.10.0

-------

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

**Closed issues:**

-  Galleries using bokeh `841 <https://github.com/sphinx-gallery/sphinx-gallery/issues/841>`__
-  TorchIO now uses sphinx-gallery `823 <https://github.com/sphinx-gallery/sphinx-gallery/issues/823>`__
-  New release `817 <https://github.com/sphinx-gallery/sphinx-gallery/issues/817>`__
-  Change DPI? `804 <https://github.com/sphinx-gallery/sphinx-gallery/issues/804>`__
-  Multiple images in horizontal list are not clickable (cannot zoom in) `429 <https://github.com/sphinx-gallery/sphinx-gallery/issues/429>`__
-  Notebook style issues with indentation `342 <https://github.com/sphinx-gallery/sphinx-gallery/issues/342>`__

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

@pyup-bot
Copy link
Copy Markdown
Collaborator Author

Closing this in favor of #435

@pyup-bot pyup-bot closed this Aug 20, 2022
@mbjoseph mbjoseph deleted the pyup-update-sphinx_gallery-0.9.0-to-0.11.0 branch August 20, 2022 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant