Sphinx-gallery

Latest version: v0.19.0

Safety actively analyzes 714919 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 5 of 8

0.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 <https://github.com/sphinx-gallery/sphinx-gallery/pull/511>`__ (`larsoner <https://github.com/larsoner>`__)
- ENH: Allow README.rst ext `510 <https://github.com/sphinx-gallery/sphinx-gallery/pull/510>`__ (`larsoner <https://github.com/larsoner>`__)
- binder requirements with Dockerfile? `476 <https://github.com/sphinx-gallery/sphinx-gallery/issues/476>`__
- ENH: Update docs `509 <https://github.com/sphinx-gallery/sphinx-gallery/pull/509>`__ (`larsoner <https://github.com/larsoner>`__)
- Add documentation note on RTD-Binder incompatibility `505 <https://github.com/sphinx-gallery/sphinx-gallery/pull/505>`__ (`StanczakDominik <https://github.com/StanczakDominik>`__)
- Add PlasmaPy to list of sphinx-gallery users `504 <https://github.com/sphinx-gallery/sphinx-gallery/pull/504>`__ (`StanczakDominik <https://github.com/StanczakDominik>`__)
- ENH: Expose example globals `502 <https://github.com/sphinx-gallery/sphinx-gallery/pull/502>`__ (`larsoner <https://github.com/larsoner>`__)
- DOC: Update docs `501 <https://github.com/sphinx-gallery/sphinx-gallery/pull/501>`__ (`larsoner <https://github.com/larsoner>`__)
- add link to view sourcecode in docs `499 <https://github.com/sphinx-gallery/sphinx-gallery/pull/499>`__ (`sappelhoff <https://github.com/sappelhoff>`__)
- MRG, ENH: Catch and write warnings `495 <https://github.com/sphinx-gallery/sphinx-gallery/pull/495>`__ (`larsoner <https://github.com/larsoner>`__)
- MRG, ENH: Add private API for external scrapers `494 <https://github.com/sphinx-gallery/sphinx-gallery/pull/494>`__ (`larsoner <https://github.com/larsoner>`__)
- Add list of external image scrapers `492 <https://github.com/sphinx-gallery/sphinx-gallery/pull/492>`__ (`banesullivan <https://github.com/banesullivan>`__)
- Add more examples of projects using sphinx-gallery `489 <https://github.com/sphinx-gallery/sphinx-gallery/pull/489>`__ (`banesullivan <https://github.com/banesullivan>`__)
- Add option to remove sphinx_gallery config comments `487 <https://github.com/sphinx-gallery/sphinx-gallery/pull/487>`__ (`timhoffm <https://github.com/timhoffm>`__)
- FIX: allow Dockerfile `477 <https://github.com/sphinx-gallery/sphinx-gallery/pull/477>`__ (`jasmainak <https://github.com/jasmainak>`__)
- MRG: Add SVG support `471 <https://github.com/sphinx-gallery/sphinx-gallery/pull/471>`__ (`larsoner <https://github.com/larsoner>`__)
- MAINT: Simplify CircleCI build `462 <https://github.com/sphinx-gallery/sphinx-gallery/pull/462>`__ (`larsoner <https://github.com/larsoner>`__)

0.3.1

------

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

**Fixed bugs:**

0.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 <https://circleci.com/docs/2.0/collect-test-data/#metadata-collection-in-custom-test-steps>`__
and `blog post <https://circleci.com/blog/how-to-output-junit-tests-through-circleci-2-0-for-expanded-insights/>`__.

**Fixed bugs:**

- First gallery plot uses .matplotlibrc rather than the matplotlib
defaults
`316 <https://github.com/sphinx-gallery/sphinx-gallery/issues/316>`__

**Merged pull requests:**

- [MRG+1]: Output JUnit XML file
`454 <https://github.com/sphinx-gallery/sphinx-gallery/pull/454>`__
(`larsoner <https://github.com/larsoner>`__)
- MRG: Use highlight_language
`453 <https://github.com/sphinx-gallery/sphinx-gallery/pull/453>`__
(`larsoner <https://github.com/larsoner>`__)
- BUG: Fix execution time writing
`451 <https://github.com/sphinx-gallery/sphinx-gallery/pull/451>`__
(`larsoner <https://github.com/larsoner>`__)
- MRG: Adjust lineno for 3.8
`450 <https://github.com/sphinx-gallery/sphinx-gallery/pull/450>`__
(`larsoner <https://github.com/larsoner>`__)
- MRG: Only rebuild necessary parts
`448 <https://github.com/sphinx-gallery/sphinx-gallery/pull/448>`__
(`larsoner <https://github.com/larsoner>`__)
- MAINT: Drop 3.4, add mayavi to one
`447 <https://github.com/sphinx-gallery/sphinx-gallery/pull/447>`__
(`larsoner <https://github.com/larsoner>`__)
- MAINT: Modernize requirements
`445 <https://github.com/sphinx-gallery/sphinx-gallery/pull/445>`__
(`larsoner <https://github.com/larsoner>`__)
- Activating travis on pre-release of python
`443 <https://github.com/sphinx-gallery/sphinx-gallery/pull/443>`__
(`NelleV <https://github.com/NelleV>`__)
- [MRG] updating binder instructions
`439 <https://github.com/sphinx-gallery/sphinx-gallery/pull/439>`__
(`choldgraf <https://github.com/choldgraf>`__)
- FIX: Fix for latest sphinx-dev
`437 <https://github.com/sphinx-gallery/sphinx-gallery/pull/437>`__
(`larsoner <https://github.com/larsoner>`__)
- adding notes for filename
`436 <https://github.com/sphinx-gallery/sphinx-gallery/pull/436>`__
(`choldgraf <https://github.com/choldgraf>`__)
- FIX: correct sorting docstring for the FileNameSortKey class
`433 <https://github.com/sphinx-gallery/sphinx-gallery/pull/433>`__
(`mrakitin <https://github.com/mrakitin>`__)
- MRG: Fix for latest pytest
`432 <https://github.com/sphinx-gallery/sphinx-gallery/pull/432>`__
(`larsoner <https://github.com/larsoner>`__)
- FIX: Bump version
`431 <https://github.com/sphinx-gallery/sphinx-gallery/pull/431>`__
(`larsoner <https://github.com/larsoner>`__)
- MRG: Fix for newer sphinx
`430 <https://github.com/sphinx-gallery/sphinx-gallery/pull/430>`__
(`larsoner <https://github.com/larsoner>`__)
- DOC: Missing perenthisis in PNGScraper
`428 <https://github.com/sphinx-gallery/sphinx-gallery/pull/428>`__
(`ksunden <https://github.com/ksunden>`__)
- Fix 425
`426 <https://github.com/sphinx-gallery/sphinx-gallery/pull/426>`__
(`Titan-C <https://github.com/Titan-C>`__)
- Scraper documentation and an image file path scraper
`417 <https://github.com/sphinx-gallery/sphinx-gallery/pull/417>`__
(`choldgraf <https://github.com/choldgraf>`__)
- MRG: Remove outdated cron job
`416 <https://github.com/sphinx-gallery/sphinx-gallery/pull/416>`__
(`larsoner <https://github.com/larsoner>`__)
- ENH: Profile memory
`415 <https://github.com/sphinx-gallery/sphinx-gallery/pull/415>`__
(`larsoner <https://github.com/larsoner>`__)
- fix typo
`414 <https://github.com/sphinx-gallery/sphinx-gallery/pull/414>`__
(`zasdfgbnm <https://github.com/zasdfgbnm>`__)
- FIX: Travis
`410 <https://github.com/sphinx-gallery/sphinx-gallery/pull/410>`__
(`larsoner <https://github.com/larsoner>`__)
- documentation index page and getting_started updates
`403 <https://github.com/sphinx-gallery/sphinx-gallery/pull/403>`__
(`choldgraf <https://github.com/choldgraf>`__)
- adding ability to customize first cell of notebooks
`401 <https://github.com/sphinx-gallery/sphinx-gallery/pull/401>`__
(`choldgraf <https://github.com/choldgraf>`__)
- spelling fix
`398 <https://github.com/sphinx-gallery/sphinx-gallery/pull/398>`__
(`amueller <https://github.com/amueller>`__)
- [MRG] Fix Circle v2
`393 <https://github.com/sphinx-gallery/sphinx-gallery/pull/393>`__
(`lesteve <https://github.com/lesteve>`__)
- MRG: Move to CircleCI V2
`392 <https://github.com/sphinx-gallery/sphinx-gallery/pull/392>`__
(`larsoner <https://github.com/larsoner>`__)
- MRG: Fix for 1.8.0 dev
`391 <https://github.com/sphinx-gallery/sphinx-gallery/pull/391>`__
(`larsoner <https://github.com/larsoner>`__)
- Drop “Total running time” when generating the documentation
`390 <https://github.com/sphinx-gallery/sphinx-gallery/pull/390>`__
(`lamby <https://github.com/lamby>`__)
- Add dedicated class for timing related block
`359 <https://github.com/sphinx-gallery/sphinx-gallery/pull/359>`__
(`ThomasG77 <https://github.com/ThomasG77>`__)
- MRG: Add timing information
`348 <https://github.com/sphinx-gallery/sphinx-gallery/pull/348>`__
(`larsoner <https://github.com/larsoner>`__)
- MRG: Add refs from docstring to backrefs
`347 <https://github.com/sphinx-gallery/sphinx-gallery/pull/347>`__
(`larsoner <https://github.com/larsoner>`__)
- API: Refactor image scraping
`313 <https://github.com/sphinx-gallery/sphinx-gallery/pull/313>`__
(`larsoner <https://github.com/larsoner>`__)
- [MRG] FIX import local modules in examples
`305 <https://github.com/sphinx-gallery/sphinx-gallery/pull/305>`__
(`NelleV <https://github.com/NelleV>`__)
- [MRG] Separate rst notebook generation from execution of the script
`239 <https://github.com/sphinx-gallery/sphinx-gallery/pull/239>`__
(`Titan-C <https://github.com/Titan-C>`__)

0.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
<https://github.com/sphinx-gallery/sphinx-gallery/pull/244>`_ and `#371
<https://github.com/sphinx-gallery/sphinx-gallery/pull/371>`_.
* Added ``ignore_pattern`` configurable to allow not adding some python files
into the gallery. See `346
<https://github.com/sphinx-gallery/sphinx-gallery/pull/346>`_ for more
details.
* Support for custom default thumbnails in 'RGBA' space `375 <https://github.com/sphinx-gallery/sphinx-gallery/pull/375>`_
* Allow title only -\> use title as first paragraph `345 <https://github.com/sphinx-gallery/sphinx-gallery/pull/345>`_

Bug Fixes
'''''''''

* Fix name string_replace trips on projects with ".py" in path. See `322
<https://github.com/sphinx-gallery/sphinx-gallery/issues/322>`_ and `#331
<https://github.com/sphinx-gallery/sphinx-gallery/issues/331>`_ for more details.
* Fix __future__ imports across cells. See `308
<https://github.com/sphinx-gallery/sphinx-gallery/pull/308>`_ for more details.
* Fix encoding related issues when locale is not UTF-8. See `311
<https://github.com/sphinx-gallery/sphinx-gallery/pull/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
<https://github.com/sphinx-gallery/sphinx-gallery/issues/301>`_ for a use
case where it matters.
* Fix SphinxDocLinkResolver error with sphinx 1.7. See `352
<https://github.com/sphinx-gallery/sphinx-gallery/pull/352>`_ for more
details.
* Fix unexpected interaction between ``file_pattern`` and
``expected_failing_examples``. See `379
<https://github.com/sphinx-gallery/sphinx-gallery/pull/379>`_ and `#335
<https://github.com/sphinx-gallery/sphinx-gallery/pull/335>`_
* FIX: Use unstyled pygments for output `384 <https://github.com/sphinx-gallery/sphinx-gallery/pull/384>`_
* Fix: Gallery name for paths ending with '/' `372 <https://github.com/sphinx-gallery/sphinx-gallery/pull/372>`_
* Fix title detection logic. `356 <https://github.com/sphinx-gallery/sphinx-gallery/pull/356>`_
* FIX: Use ``docutils_namespace`` to avoid warning in sphinx 1.8dev `387 <https://github.com/sphinx-gallery/sphinx-gallery/pull/387>`_

Incompatible Changes
''''''''''''''''''''

* Removed optipng feature that was triggered when the ``SKLEARN_DOC_OPTIPNG``
variable was set. See `349
<https://github.com/sphinx-gallery/sphinx-gallery/pull/349>`_ for more
details.
* ``Backreferences_dir`` is now mandatory `307 <https://github.com/sphinx-gallery/sphinx-gallery/pull/307>`_

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

* Dropped support for Sphinx <= 1.4.
* Add SphinxAppWrapper class in ``test_gen_gallery.py`` `386 <https://github.com/sphinx-gallery/sphinx-gallery/pull/386>`_
* Notes on how to do a release `360 <https://github.com/sphinx-gallery/sphinx-gallery/pull/360>`_
* Add codecov support `328 <https://github.com/sphinx-gallery/sphinx-gallery/pull/328>`_

0.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 <https://github.com/sphinx-gallery/sphinx-gallery/pull/283>`_
* Use intersphinx for all function reference resolution `296 <https://github.com/sphinx-gallery/sphinx-gallery/pull/296>`_
* Sphinx only directive for downloads `298 <https://github.com/sphinx-gallery/sphinx-gallery/pull/298>`_
* Allow sorting subsection files `281 <https://github.com/sphinx-gallery/sphinx-gallery/pull/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 <https://github.com/sphinx-gallery/sphinx-gallery/issues/287>`_
* Fix gzip/BytesIO error `293 <https://github.com/sphinx-gallery/sphinx-gallery/pull/293>`_
* Deactivate virtualenv provided by Travis `294 <https://github.com/sphinx-gallery/sphinx-gallery/pull/294>`_

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

* Push the docs from Circle CI into github `268 <https://github.com/sphinx-gallery/sphinx-gallery/pull/268>`_
* Report version to sphinx. `292 <https://github.com/sphinx-gallery/sphinx-gallery/pull/292>`_
* Minor changes to log format. `285 <https://github.com/sphinx-gallery/sphinx-gallery/pull/285>`_ and `#291 <https://github.com/sphinx-gallery/sphinx-gallery/pull/291>`_

0.1.12

-------

New features
''''''''''''

* Implement a explicit order sortkey to specify the subsection's order
within a gallery. Refer to discussion in
`37 <https://github.com/sphinx-gallery/sphinx-gallery/issues/37>`_,
`233 <https://github.com/sphinx-gallery/sphinx-gallery/pull/233>`_ and
`234 <https://github.com/sphinx-gallery/sphinx-gallery/pull/234>`_
* Cleanup console output during build
`250 <https://github.com/sphinx-gallery/sphinx-gallery/pull/250>`_
* New configuration Test
`225 <https://github.com/sphinx-gallery/sphinx-gallery/pull/225>`_

Bug Fixes
'''''''''

* Reset ``sys.argv`` before running each example. See
`252 <https://github.com/sphinx-gallery/sphinx-gallery/pull/252>`_
for more details.
* Correctly re-raise errors in doc resolver. See
`264 <https://github.com/sphinx-gallery/sphinx-gallery/pull/264>`_.
* Allow and use https links where possible
`258 <https://github.com/sphinx-gallery/sphinx-gallery/pull/258>`_.
* Escape tooltips for any HTML special characters.
`249 <https://github.com/sphinx-gallery/sphinx-gallery/pull/249>`_

Documentation
'''''''''''''''

* Update link to numpy to point to latest
`271 <https://github.com/sphinx-gallery/sphinx-gallery/pull/271>`_
* Added documentation dependencies.
`267 <https://github.com/sphinx-gallery/sphinx-gallery/pull/267>`_

Page 5 of 8

© 2025 Safety CLI Cybersecurity Inc. All Rights Reserved.