DOC: switching to use the plot directive #23814
Conversation
none of the rest triggered pop-ups yet during testing, so it's not totally necessary. But if cleanup is preferred, maybe this could be an extra-low-hanging fruit for a sprint where participants want to practice the contributing process more than actual code development. |
|
It seems like things are not going through because |
Oh, interesting. That should have triggered a build failure. (and I have only tested locally with the hanning plots, those showed up) |
|
I don't see any more plot-generating errors, and opened #23821 to follow-up on why circleCI giving a false green status. |
|
Thanks for fixing the import issue, the plots look good now. Let's put this in, hopefully it helps with pushing the larger changes! |
These examples in the docstrings seem to have the sole purpose of generating the plot, there isn't anything in them that should be tested, and the pop-up windows somewhat annoying when running the tests locally.
Therefore, after consulting with @seberg, we think it's better to switch to use the
plotdirective. Whether the code is executing without error or not will be checked during the sphinx-build, no need to run the doctests, too.(This came up during #23812, but that PR will be monster big, and thus I'm chopping it up to smaller pieces. Also, there are more plots generated in the API docs, but those were not triggering pop-up windows)