feat: enable matplotlib and plotly in examples #567
+1,498
−27
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
github-actions
bot
added
the
enhancement
jorgepiloto
changed the title
jorgepiloto
commented
Oct 25, 2024
|
Plotly and matplotlib are supported. Main issue here is that the different extensions are getting in conflict because "sphinx-gallery" generates a bunch of files. Still working on it. |
Revathyvenugopal162
approved these changes
Oct 28, 2024
MaxJPRey
reviewed
Oct 28, 2024
MaxJPRey
reviewed
Oct 28, 2024
MaxJPRey
reviewed
Oct 28, 2024
doc/source/conf.py
Outdated
|
|
||
|
|
||
| def revert_gallery_patterns(app, builder): | ||
| """Revert the gallery excluded patterns.""" |
There was a problem hiding this comment.
Me might give more explanations here for this revert.
MaxJPRey
reviewed
Oct 28, 2024
doc/source/conf.py
Outdated
| def revert_gallery_patterns(app, builder): | ||
| """Revert the gallery excluded patterns.""" | ||
| excluded_gallery_pattern = app.config.exclude_patterns | ||
| excluded_gallery_pattern.remove("examples/gallery-examples/*.ipynb") |
There was a problem hiding this comment.
What if gallery-examplesdo not exist?
Are we handling the ValueError that will be raised later?
jorgepiloto
commented
Oct 29, 2024
jorgepiloto
commented
Oct 29, 2024
doc/source/conf.py
Outdated
| # Remove the "Download all examples" button from the top level gallery | ||
| "download_all_examples": False, | ||
| # Modules for which function level galleries are created. In | ||
| "image_scrapers": ("pyvista", "matplotlib"), | ||
| "image_scrapers": ("pyvista", "matplotlib", plotly_sg_scraper), |
There was a problem hiding this comment.
Thanks for adding this one.
jorgepiloto
commented
Oct 29, 2024
doc/source/conf.py
Outdated
Comment on lines
305
to
314
| def revert_exclude_patterns(app, env): | ||
| """Revert the exclude patterns.""" | ||
| excluded_pattern = env.config.exclude_patterns | ||
| excluded_pattern.remove("examples/gallery-examples/*.ipynb") | ||
| env.config.exclude_patterns = excluded_pattern | ||
|
|
||
|
|
||
| def setup(app: Sphinx) -> Dict: | ||
| """Sphinx hooks to add to the setup.""" | ||
| app.connect("env-updated", revert_exclude_patterns) |
There was a problem hiding this comment.
Nice hack, @Revathyvenugopal162!
There was a problem hiding this comment.
Could we add some information about it. Whether it is a docstring or similar.
Co-authored-by: Maxime Rey <[email protected]>
Co-authored-by: Maxime Rey <[email protected]>
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.
This pull-request fixes #301 by ensuring plotly is supported in our theme. Matplotlib support is explored too.