Sphinx Gallery Versions Save

Sphinx extension for automatic generation of an example gallery

v0.4.0

4 years ago

Full Changelog

Implemented enhancements:

Fixed bugs:

Closed issues:

  • Allow .rst extension for README files #508
  • Generation of unchanged examples #506
  • Binder integration and Read the docs #503
  • Extending figure_rst to support html figures? #498
  • ENH: remove API crossrefs from hover text #497
  • BUG: warnings/stderr not captured #491
  • Should image\_scrapers be renamed (to output\_scrapers for example)? #485
  • Strip in-file sphinx_gallery directives from code #481
  • Generating gallery sometimes freezes #479
  • Adding a ReST block immediately after the module docstring breaks the generated .rst file #473
  • how to make custom image scraper #469
  • pythonhosted.org seems to be still up and running #465
  • Small regression in 0.3.1 with output figure numbering #464
  • Change output format of images #463
  • Version 0.3.0 release is broken on pypi #459
  • sphinx-gallery doesn't play nice with sphinx's ability to detect new files... #449
  • Remove the readthedocs version of sphinx gallery docs #444
  • Support for Plotly #441
  • Release v0.3.0 #406
  • Unnecessary regeneration of example pages #395
  • Unnecessary regeneration of API docs #394

v0.3.0

5 years ago

v0.3.0

Full Changelog

Implemented enhancements:

  • Section labels should be inserted in the index.rst of the gallery #127
  • Include a reference for each gallery subsection #131 (Titan-C)

Fixed bugs:

  • First gallery plot uses .matplotlibrc rather than the matplotlib defaults #316

Closed issues:

  • SG not respecting highlight_lang in conf.py #452
  • sphinx-gallery doesn't play nice with sphinx's ability to detect new files... #449
  • gallery generation broken on cpython master #442
  • Improve binder button instructions #438
  • Won't display stdout #435
  • realtive paths in github.io #434
  • 'make html' does not attempt to run examples #425
  • Sprint tomorrow @ euroscipy? #412
  • Release v0.3.0 #409
  • Supported Python and Sphinx versions #404
  • How to get the .css files to copy over on building the docs? #399
  • feature request: only rebuild individual examples #397
  • Unnecessary regeneration of example pages #395
  • Unnecessary regeneration of API docs #394
  • matplotlib inline vs notebook #388
  • Can this work for files other than .py ? #378
  • v0.1.14 release plan #344
  • SG misses classes that aren't imported #205
  • Add a page showing the time taken by the examples #203
  • Lack of install\_requires #192

Merged pull requests:

v0.2.0

5 years ago

Fixed bugs:

  • Surprising interaction between file_pattern and expected_failing_examples #335

Closed issues:

  • Feature request: Different ordering options #369
  • Option to insert a preamble in index.rst #315
  • Sphinx 1.7.5 causes ValueError in parse_sphinx_docopts #382
  • How to link the gallery #380
  • download_section_examples implemented? #376
  • fails to build with recent matplotlib #373
  • Create output folder configurable option #368
  • plot_gallery=False working as expected? #366
  • ignore code-blocks #361
  • A grant for sphinx-gallery? #355
  • JupyterLab support on binder #353
  • Error with Sphinx 1.7 due to changes in DOCUMENTATION_OPTIONS #351
  • Rendering issues with scripts using docopt #341
  • The "floating buttons box" still needs some work #340
  • Enhancement binder: more flexibility with filepath #338
  • No support for numpydoc #333
  • I'm gonna be in paris tomorrow :-) #323
  • name string_replace trips on projects with ".py" in path #322
  • Run sphinx-gallery on just one file? #321
  • What is SKLEARN_DOC_OPTIPNG about? #319
  • SKLEARN_DOC_OPTIPNG #318
  • Failure : 'Sphinx' object has no attribute '_extensions' #310
  • Is there a poster for sphinx-gallery? #309
  • ipynb file not created #306
  • Having plot\_gallery as a bool in conf.py raises warning #302
  • option to control verbosity #301
  • Problem compiling from py to rst with unicode when local is not defined on mac #269
  • Possible to ignore a file with sphinx-gallery? #262
  • Test embeding of links in source blocks #260
  • Adding a link to Binder in examples #238
  • SG incorrectly grabbing the description when a label is defined in docstring #232
  • Code getting run even though it doesn't match the pattern? #224
  • Make example text optional #222
  • Allow option to not display total running time in the rendered docs #221
  • CSS class of images is a bit generic #209
  • Some external functions / classes don't resolve into links #113
  • Sphinx treats gallery images as headers #6

Merged pull requests:

v0.1.13

6 years ago

Fixed bugs:

  • Crasher in doc_resolv, in js_index.loads #287
  • Attribute error on sphinx master #270

Closed issues:

  • Error when building examples #299
  • Download button and 'generated by sphinx-gallery' should be only:: html #297
  • "Generated by sphinx-gallery" should be replaced by "Gallery generated by sphinx-gallery" #288
  • Issue with interative plot and notebook style #284
  • BUG: pillarboxes are added to square images when scaling thumbnails #282
  • ENH: Add thumbnail size setter #277
  • DOC: List all conf options in one place #276
  • ENH: Allow setting example order #275
  • Confusing line numbers in traceback #248

Merged pull requests:

v0.1.12

6 years ago

Closed issues:

  • Problem with examples using sys.argv e.g. through argparse.ArgumentParser #251
  • sphinx deprecation warning #247
  • tooltips need to escape some characters #237
  • Unable to use https in reference_url #236
  • Console output is very verbose #230
  • Wish: ordering of example gallery (and sphinx table of contents) #37

Merged pull requests:

  • [MAINT] Update link to numpy to point to latest #271 (NelleV)
  • [MRG+1] [DOC] Added documentation dependencies. #267 (NelleV)
  • [MRG+1] ENH parallelization is now possible #266 (NelleV)
  • Correctly re-raise errors in doc resolver. #264 (QuLogic)
  • Revert "Enforce UTF8 encoding in backreferences" #259 (Titan-C)
  • Allow and use https links where possible #258 (QuLogic)
  • Enforce UTF8 encoding in backreferences #257 (pllim)
  • [MRG+1]: Use unicode #256 (Eric89GXL)
  • Fix for when sys.argv is used in examples #252 (lesteve)
  • Cleanup console output during build #250 (QuLogic)
  • Escape tooltips for any HTML special characters. #249 (QuLogic)
  • BUG: Fix reading with non-utf-8 default encoding #246 (dopplershift)
  • [MRG] Other gallery subsection sorter #234 (Titan-C)
  • [MRG] Testing configuration #225 (Titan-C)

Fixed bugs:

  • No active exception to raise #213

v0.1.11

7 years ago

Closed issues:

  • sphinx 1.6.1 #241
  • Possible to show the same figure multiple times? #240
  • Use bbox\_inches="tight" in savefig #235
  • Some text is being handled differently by SG #231
  • Large whitespace after TOC in a gallery #226
  • NameError: name '__file__' is not defined #211

Merged pull requests:

v0.1.10

7 years ago

Closed issues:

  • "image file not readable" with 0.1.9 #229
  • Is there a way to specify custom backreferences in a docstring? #228
  • backreferences_dir vs. mod_example_dir? #227

v0.1.9

7 years ago

Incompatible Changes:

Closed issues:

  • Plot with legend aside of the axis within a figure #215
  • Notebook styled examples without execution #204
  • Orphan boxes in the gallery? #202
  • Add conda environment.yml with mayavi on readthedocs #200
  • Rendering HTML in examples #199
  • Support of other languages #194
  • Zip files containing all the notebooks not available on Windows #183
  • Move to py.test #163
  • Add "fork me on github" banner #159
  • BUG: Spamming of warnings about .exclude #126
  • Hyperlinks in code don't work in current use of autosummary #70

Merged pull requests:

v0.1.8

7 years ago

Implemented enhancements:

  • More informative messages when skipping an example #167

Fixed bugs:

  • SyntaxError in example files crashes the complete build #129

Closed issues:

  • [sphinx 1.5] _gdbm.error No such file or directory #186
  • Exception occurred in _get_data (IOError) #184
  • Relative paths of example directories not relative to doc root #50

Merged pull requests:

  • [MRG] Fix :orphan: sphinx-directive multiple calls #198 (Titan-C)
  • README states that dependencies are on the user's responsibility #193 (Titan-C)
  • [MRG] Remove nonfunctional text2string function #191 (naoyak)
  • [MRG] Better path handling #190 (Titan-C)
  • cached conda gives problems in new Circle CI Builds #189 (Titan-C)
  • ENH: Add CircleCI #188 (Eric89GXL)
  • ENH: Cleaner output #187 (Eric89GXL)
  • [MRG] Drop styling of codelinks tooltip use title #185 (Titan-C)
  • [MRG] Build gallery when example has SyntaxError #177 (Titan-C)

v0.1.7

7 years ago

Closed issues:

  • Build breaks on sphinx 1.5 #180

Implemented enhancements:

  • Add AppVeyor to test sphinx-gallery on Windows #162

Merged pull requests: