ENH: Cleaner output #187
Merged
ENH: Cleaner output #187
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
Sample log: BTW, anybody ever thought of setting up CircleCI with artifacts so that the build results could be viewed? Might be useful for assessing aesthetic changes. I can set it up if people agree it would be useful. |
Titan-C
reviewed
Dec 17, 2016
sphinx_gallery/docs_resolv.py
Outdated
| line = expr.sub(substitute_link, line) | ||
| fid.write(line.encode('utf-8')) | ||
| print('[done]') | ||
| # This could |
Contributor
Author
|
Thanks @Titan-C, fixed the comment |
Member
I googled the other day and it does not look like readthedocs supports generating the doc for PRs. That would be great to have CircleCI for PR to quickly double-check the generated docs. |
Member
|
LGTM, merging, thanks a lot! |
Member
This was referenced Jan 17, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This does two things:
Suppresses output when doing
plot_gallery=Falsesaying it took 0 seconds to run a bunch of examples that didn't run. It's not very informative, and it makes the sphinx output very long, thus making things like checking for good sphink markup, bad links, etc. harder (whatplot_gallery=Falseis mostly used for, I assume).Uses
app.status_iteratorfor the last stage of processing where code is embedded. Instead of having tens or hundreds of lines, now the output looks like the rest of sphinx, e.g.: