Hide sphinx-gallery config comments #15646
Merged
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
QuLogic
approved these changes
Nov 10, 2019
dstansby
approved these changes
Nov 11, 2019
|
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulation you did some good work ! Hopefully your backport PR will be tested by the continuous integration and merged soon! If these instruction are inaccurate, feel free to suggest an improvement. |
|
3.2.0 is in rc; we should not bump minimum requirements at this stage, even if it's just for docs. |
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.
PR Summary
This activates the new sphinx-gallery config option
remove_config_commentswhich removes comments like# sphinx_gallery_thumbnail_number = 2(e.g. in the code at https://matplotlib.org/devdocs/gallery/lines_bars_and_markers/fill_between_demo.html#example-confidence-bands). These do only controll sphinx-gallery behavior, they are not relevant for the viewer of the docs, and are rather confusing.This requires
sphinx-gallery>=0.4and thus bumps the minimum needed version (but that's rather uncritical because it's only needed for doc builds and not affecting the end-user).