Conversation
|
I changed the comment to I am a bit frustrated because my general feeling during this whole PR is that on the one hand sphinx-gallery is rather opinionated about how it should be used, but on the other hand that API feels incomplete / half-baked. 😕 I just wanted to simplify the way that examples are configured for the gallery, but it got me jumping hoops. Aaaanyway ... I'm now on the fence about two options: # Kinda what we have now. The "problem" is that the second comment is shown in the code in the gallery.
# sphinx_gallery_pygfx = 'screenshot'
# example_testing = compare'
import pygfx as gfx
...vs # If we re-use/mis-use the gallery option mechanism, sphinx will remove both comments from the gallery code.
# sphinx_gallery_pygfx_docs = 'screenshot'
# sphinx_gallery_pygfx_test = compare'
import pygfx as gfx
... |
|
I honestly don't care. Either option is fine if we document it. People will just copy paste whatever we have anyway. |
yup! does anyone actually know how sphinx works fully 😆 |
Korijn
left a comment
There was a problem hiding this comment.
Are you going to port some of these changes to wgpu-py as well?
|
We don't have a gallery there, so I guess not? Perhaps if/when wgpu-py gets some more examples ... |
|
Well, the changes you made to the example testing stuff for example. |
|
Yeah, I can apply that to wgpu too, for consistency. |
Done
target_nameby making the canvas-selection a wee bit smarter.sphinx_gallery_pygfx_docscomment to control per-file gallery config.sphinx_gallery_pygfx_testcomment to control per-file test config.