MatthewFlamm / pyransame

PYthon RAndom SAmpling for MEshes
https://matthewflamm.github.io/pyransame/
MIT License
12 stars 0 forks source link

Use the new PyVista sphinx directives for interactive plots in the documentation? #133

Closed banesullivan closed 9 months ago

banesullivan commented 9 months ago

It'd be great to make the documentation examples interactive! I'll see if I can make some time to contribute this while on winter holiday

MatthewFlamm commented 9 months ago

Direct help or some pointers would be very much appreciated. I see where the DynamicScraper is specified for sphinx_gallery in pyvista conf.py, but this package does not use this Sphinx plugin. Is it required? It seems to me that interactive is opt-out through specifying force_static yet there must be some opt-in mechanism I cannot find.

banesullivan commented 9 months ago

Its all done directly through the pyvista-plot directive nowm so no need for the new dynamic scraper (that's specific to sphinx-gallery)

banesullivan commented 9 months ago

If you want a specific plot to opt-out of the dynamic rendering, you can specify force_static in the directive options:

.. pyvista-plot::
   :force_static: