Tweaks to generating the examples gallery #583
Merged
Conversation
This file contains 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
… time docs are generated, only after rm -rf _build/* rm -f extensions.py rm -f *.dat *.sav *.csv rm -rf examples/* rm -rf ../examples/documentation
reneeotten
requested changes
Aug 23, 2019
There was a problem hiding this comment.
thanks @newville! I like the idea of not generating the gallery every time even if there are no changes, so I like your Makefile-voodoo. I have left a few small review comments.
Codecov Report
@@ Coverage Diff @@
## master #583 +/- ##
======================================
Coverage 86.5% 86.5%
======================================
Files 11 11
Lines 3252 3252
======================================
Hits 2813 2813
Misses 439 439Continue to review full report at Codecov.
|
reneeotten
approved these changes
Aug 24, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
These are all changes to the doc and build scripts for the examples gallery.
I added "Gallery" to the upper-right section of the doc, just to make it more visible.
I tweaked the gallery generation script. In the end, this is mostly adding suppression of warnings.
I also changed the Makefile so that the gallery isn't generated every time
sphinx-buildis run, but only when the gallery is empty (as aftermake clean).@reneeotten Let me know if any of these seem wrong or you don't like any part of this.
Type of Changes
Tested on
Tested with all the sphinx tools up-to-date from Anaconda Python 3.7