docs: fix docs/conf.py plot_gallery warning #4539
Merged
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.
🚀 Pull Request
Description
This PR resolves the following warning which is raised when building the documentation with
![image](https://user-images.githubusercontent.com/2051656/151198345-595be102-c9d5-4631-aa35-d37c2ea3797b.png)
html-noplot
orhtml-quick
Also see:
plot_gallery
as a bool in conf.py raises warning sphinx-gallery/sphinx-gallery#302Note that, the
plot_gallery=0
directive tomake
within thedocs/src/Makefile
ensures that the documentation gallery is not built.Consult Iris pull request check list