sphinx-gallery

sphinx-gallery copied to clipboard

ENH: Collapse some code blocks

11

Side-remark: It would be really cool if one could specify that individual code sections can be/are folded (or maybe completely omitted?) in sphinx-gallery. This is one of the gallery entries...

larsoner

WIP: partial fix to #936. Since I'm not experienced enough when it comes to tests, I was not yet able to correct the test functions to reach the 100% success...

mchaaler

[WIP] sphinx_gallery_expected_error code-block directive

3

Will fix #912

smarie

Outsource the "pure python notebook" lib

8

Today while working on #930, thinking that I was going to duplicate the fix for mkdocs-gallery (#895), I asked myself what could be the scope of a common core lib...

smarie

Unmodified expected_failing examples are not covered by md5 check

1

... and thus get executed for each build, which seems improvable. This behavior has been mentioned in https://github.com/smarie/mkdocs-gallery/issues/34, with a detailed analysis in [this comment](https://github.com/smarie/mkdocs-gallery/pull/39#issuecomment-1079731480). The [PR fixing the issue](https://github.com/smarie/mkdocs-gallery/pull/39)...

mchaaler

Do not use [`pickle.HIGHEST_PROTOCOL`](https://docs.python.org/3.10/library/pickle.html#data-stream-format) when pickling the codeobj files. As far as I can tell, nothing is gained by that in this context, but it makes examples generated with Python...

ntessore

@StefRe working on using the exclusion of implicit refs for MNE-Python, it occurred to me that it would be nice to have a way for SG to tell me what...

larsoner

`html-noplot` does not work with strict build options

3

The [official instructions](https://sphinx-gallery.github.io/stable/configuration.html#building-without-executing-examples) for building `html-noplot` include setting `-D plot_gallery=0 -b html $(ALLSPHINXOPTS)`. This will emit the following warning: ``` The config value `plot_gallery' has type `str', defaults to `bool'....

pmeier

Add unique output block references for literalinclude

10

It's sometimes useful to reference code block output in addition to produced images (using `figure`) or code lines (using `literalinclude`), so this change adds comments to the produced RST file...

romanlutz

Consider adding a `sphinx_gallery_expected_error` code-block option to show an expected error

2

( From https://github.com/smarie/mkdocs-gallery/issues/23 ) Sometimes we write a code block to show the reader that something raises an error. It is a bit tideous to have to try/catch this error...

smarie