[MRG+1] Traceback message in Gallery output #77
Conversation
|
that's fine with me other option is to stop the doc build with a meaningful crash message |
It should be controlled by an option (just like the building of the |
My 2 cents: I think the current behaviour is fine for now. The general use case is to build all the examples to find all the broken ones rather than fail on the first error. Something I would actually find useful (not sure how easy this is): have a special image for broken examples allowing them to identify quite easily in the gallery. |
sphinx_gallery/gen_rst.py
Outdated
There was a problem hiding this comment.
Nitpick: in order not to do traceback.print_exc() and then traceback.format_exc() which is kind of doing the same thing twice, you can do:
formatted_exception = traceback.format_exc()
print(formatted_exception)
exception_msg = indent(formatted_exception, ' ' * 4)
|
Just tried this out and here is a snapshot:
It would be nice to have a fixed-width font in the HTML traceback. This makes a huge difference for long tracebacks. |
|
Now it's improved. |
The image thing is quite nice, although we can think about tweaking the "broken" image. I still get non fixed-width font in the warnings when generating the gallery locally though. |
No idea here. What does you browser tell you the CSS style is. The block shall be a sphx-glr-traceback. That one has no style for fonts. The example I'm providing gives me this
|
|
I have to say not sure whether the technical term for it is fixed-font or not but basically what I was trying to say is that I would have the same font in the traceback and in the code cell. |
I just learned that is syntax hightlighting for python traceback messages. Thus I'm making the traceback outputs be parsed as that. Plus an additional light red box to call attention is a traceback and that the example fails.
|
Titan-C
force-pushed
the
Traceback
branch
2 times, most recently
from
f363e74 to
2da5e45
Compare
|
As here I change some CSS I would like PR #80 to be merged first. This branch is already rebased to it, but it did not generate a branch dependency as I expected. |
|
is it possible to have the build stop if an example fails? to me that should be the default behavior. It happened to me too many times to push a website update with broken examples... it happens quickly when you have dozens of examples. |
|
I added the quick fail option to break the gallery build process as soon as an example trows an Exception, added the documentation what to put in the makefile for that. But I have not made it the default behavior, as building the complete gallery and scanning for the broken examples visually from the rendered website seems more intuitive for me. You can vote on that. |
doc/advanced_configuration.rst
Outdated
There was a problem hiding this comment.
take -> takes
display -> to display
|
besides LGTM |
sphinx_gallery/gen_rst.py
Outdated
There was a problem hiding this comment.
For readability, I would suggest being explicit about the keyword argument here, by writing:
..., lang='pytb')
|
I agree with your various design choices (in particular the default). +1 for merge. I have suggested a tiny style change. |
|
it's fine to merge as is for me thx @Titan-C |
doc/Makefile
Outdated
There was a problem hiding this comment.
maybe html-quick-fail in order not to mix - and _
|
Is broken_stamp.svg actually used? Slightly related is do you know why the "broken" image png appears with a black background in the gallery: |
|
My contribution for the 'quick_fail' naming: abort_on_example_error. |
|
Could you rebase on master so that we make sure no extra CSS changes has slipped through in this PR? |
|
broken_stamp.svg is not used now, but is the source of for the png file. Not sure if it will become useful in the future if we want to tune the image or if #61 The background of the image is black in the thumbnails because in the sphinx-classic css theme all body backgrounds are black, and the png image is transparent. |
examples/plot_raise.py
Outdated
There was a problem hiding this comment.
Singular seems more fitting here: Example that fails to execute
|
Overall, LGTM. +1 for merge (ideally, please address the comments of the others). |
GaelVaroquaux
changed the title
|
fine with me |
This allows easy identification of failled examples in the gallery view
Sphinx with Pygments provides syntax highlighting for python traceback messages is the same way as for python code. Use those
The current gallery behavior is that when using the no plot flag during build the whole gallery building process is skipped. Now, all examples are parsed into rst files but not executed, embedding of links to documentation in not performed either
|
Rebased to master and comments addressed |
|
@agramfort was good with this. I am too. Let's merge! |
[MRG+1] Traceback message in Gallery output
4 participants
This PR need comments.
First there is the situation of how to deal with a broken build #45, discussion shall continue there.
Here I address, for the moment, that the traceback of a broken example should be also printed in the HTML output of the gallery following my comment on #65 (comment)