Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Don't put examples output in sphinx-build stdout? #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Titan-C opened this issue Oct 23, 2015 · 7 comments
Closed

Don't put examples output in sphinx-build stdout? #65

Titan-C opened this issue Oct 23, 2015 · 7 comments

Comments

@Titan-C
Copy link
Member

Titan-C commented Oct 23, 2015

I was wondering if it is necessary to put the stdout of the examples in the build as is done. Would it be better to hide it and instead only output those which failed.
Currently I want to debug why some nilearn examples are not building nilearn/nilearn#592 and I notice that in stdout there is no traceback, and in the rendered html example I only get the message that the script didn't compile.

@agramfort
Copy link
Contributor

agramfort commented Oct 25, 2015 via email

@GaelVaroquaux
Copy link
Contributor

GaelVaroquaux commented Oct 25, 2015 via email

@lesteve
Copy link
Member

lesteve commented Oct 27, 2015

I notice that in stdout there is no traceback, and in the rendered html example I only get the message that the script didn't compile.

But the traceback should be in stderr, right ? I am pretty sure at one point you would see the traceback in the example HTML.

@GaelVaroquaux
Copy link
Contributor

GaelVaroquaux commented Oct 27, 2015 via email

@Titan-C
Copy link
Member Author

Titan-C commented Oct 27, 2015

do you mean not show stdout in final pages? I like having them.
So do I actually. When an example is very slow, it is good to have them
to show progress.

stdout goes always to the final pages. I was claiming that during the build process you get all the stdout of all the examples in the same terminal and is just a mess of text. So, I think it might be nicer not to show it.
Maybe to show progress put an indicator(that might be to complex and not a priority)

But the traceback should be in stderr, right ? I am pretty sure at one point
you would see the traceback in the example HTML.
That's certainly something that we would like to have.

The traceback is printed but becomes hard to find among all the other successful stdout of the other examples. Also it might be possible to keep track of which file is failing because now the execution is done by blocks which have no link to the original file besides the stdout claiming before which file got executed(you also loose the line number correspondence)

Finaly, traceback is not printed in the rendered HTML. I'm starting to think that might be useful.

@lesteve
Copy link
Member

lesteve commented Oct 27, 2015

Finaly, traceback is not printed in the rendered HTML. I'm starting to think that might be useful.

I seem to remember it was the case in nilearn at one point but maybe I just dreamt about it!

@Titan-C
Copy link
Member Author

Titan-C commented Aug 3, 2016

After merging #97 closing this.
The output of a script is written to stdout during build to have the feeling of progress. Errors are written to stderr, and on the rendered example, plus a summary at the end with the traceback.

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

No branches or pull requests

4 participants