Fix two minor issues causing noise in docs or doc build #2908
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
Codecov Report
@@ Coverage Diff @@
## main #2908 +/- ##
=======================================
Coverage 94.30% 94.30%
=======================================
Files 76 76
Lines 16527 16527
=======================================
Hits 15586 15586
Misses 941 941 |
akaszynski
previously approved these changes
Jun 29, 2022
|
So close 😄 I haven't looked at the artifact yet. |
|
Oh wow, this one |
|
OK, one small piece of the issue is that Side note: we also have a few gifs that are called >>> import pathlib
>>> import matplotlib.pyplot as plt
>>> dir = pathlib.Path('doc/_build/html/_images/')
>>> files = dir.glob('**/*.png')
>>> for file in files:
... try:
... img = plt.imread(file)
... except:
... print(file)
...
doc/_build/html/_images/sphx_glr_orbit_003.png
doc/_build/html/_images/sphx_glr_reader_002.png
doc/_build/html/_images/sphx_glr_linked_001.png
doc/_build/html/_images/sphx_glr_gif_001.png
doc/_build/html/_images/sphx_glr_collisions_001.png
doc/_build/html/_images/sphx_glr_texture_007.png
doc/_build/html/_images/sphx_glr_orbit_002.png
doc/_build/html/_images/sphx_glr_orbit_001.png
doc/_build/html/_images/sphx_glr_image-fft-perlin-noise_006.png
doc/_build/html/_images/sphx_glr_isovalue_001.png
doc/_build/html/_images/sphx_glr_moving_cmap_001.pngI bet these are all the examples gallery gifs. |
3 tasks
adeak
commented
Jun 29, 2022
| @@ -417,6 +417,7 @@ def set_background(self, color, top=None, all_renderers=True): | |||
| >>> plotter.set_background('black') | |||
| >>> plotter.background_color | |||
| Color(name='black', hex='#000000ff') | |||
| >>> plotter.close() | |||
There was a problem hiding this comment.
This will work after #2907.
* upstream/main: Add setup and teardown functionality to plot_directive (pyvista#2907) Update hypothesis requirement from <6.48.4 to <6.49.2 (pyvista#2942) Bump lxml from 4.9.0 to 4.9.1 (pyvista#2936) Bump typing-extensions from 4.2.0 to 4.3.0 (pyvista#2939) Update hypothesis requirement from <6.48.3 to <6.48.4 (pyvista#2938) Bump trimesh from 3.12.6 to 3.12.7 (pyvista#2937) Update information of release (pyvista#2911) update pre-commit hooks (pyvista#2931) Handle invalid theme on init (pyvista#2917) Add `py.typed` Marker (pyvista#2904) [create-pull-request] update local intersphinx (pyvista#2926) Add tags with python commands to avoid misnumbering (pyvista#2416) Fix the url link of discretize (pyvista#2914) Add DataSet.cell_point_ids (pyvista#2897) Update hypothesis requirement from <6.48.2 to <6.48.3 (pyvista#2918) Ensure data remains a shallow copy when added to plotter (pyvista#2888)
|
CI and local build works, only error is due to #2901. |
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.
Found two minor issues while working on other, build-heavy PRs.
The first one (warning from
read_legacy()doctest) I would've fixed in #2892 but we probably won't merge that. It makes more sense to fix these in a separate PR.The second one is a subtle issue where our plot directive collects all existing plots, so if there's a dangling plotter it gets rendered too, even if it doesn't have any
show()calls. (Not sure if we want to try to catch this; sounds too complex and too error-prone).From https://dev.pyvista.org/api/plotting/_autosummary/pyvista.Plotter.set_background.html in devdocs:
What I think happens is that the first
plotteris kept open, so when we define a new plotter with nameplin the second test the first one is still around. We can either close the first plotter, or make sure to name the second plotter the same as the first one. I went with the former solution for now.Needs: