MatthewFlamm / pyransame

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

Update docs with interactive examples #136

Closed banesullivan closed 7 months ago

banesullivan commented 7 months ago

I think this is all that is needed to resolve #133 -- at least its working locally for me. I suspect we might need to add other dependencies though? Let's see if CI is happy

I also changed the API docs so that that the long function names weren't appearing in the navbar

banesullivan commented 7 months ago

@MatthewFlamm, one suggestion I have is to turn on edge visibility in the global theme for the docs here. I think it helps alot to show the cell edges and where the sampled points lie with respect to the cells and their resolution

MatthewFlamm commented 7 months ago

Thanks! This still isn't working for me, at least on a codespaces container, but maybe there is some additional port forwarding I need to do. I won't have a local machine for testing for awhile. I did:

pip install -r requirements-doc.txt
cd doc
make html
make serve-html
codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (2cea6be) 99.13% compared to head (0bd8cfc) 99.13%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #136 +/- ## ======================================= Coverage 99.13% 99.13% ======================================= Files 5 5 Lines 345 345 ======================================= Hits 342 342 Misses 3 3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

MatthewFlamm commented 7 months ago

I had tested that installing all the PyVista requirements for documentation worked. I tried uninstalling those and then added sphinx-toolbox back and it worked. But, there must be some sub-dependency that is also required as just adding sphinx-toolbox does not work for me.

I can confirm that serving the html from codespaces works as expected.

MatthewFlamm commented 7 months ago

Some dependency, or dependencies, of jupyterlab are required. I don't think jupyterlab itself is required as I had uninstalled it originally and it had worked. But it is probably easiest just to keep that top level dependency for now.

MatthewFlamm commented 6 months ago

Coming back to this, I pushed the changes to GitHub Pages, so this is now live. It looks great. Thanks for your help on this again! I also switched over to using sphinx-gallery for most of the heavy lifting as the ability to mix plots and code output with preserving state across blocks is really useful.

I had to revamp the examples to use glyphs for spheres as pv.add_points(mesh, render_points_as_spheres=True) leads to spheres that stay constant size with respect to the viewport rather than the mesh. The interactive plots didn't work well in that case.

banesullivan commented 6 months ago

Thanks for pointing that out! I too have come back to this PR a few times to see how its done to repeat in work like https://github.com/bjlittle/geovista/pull/632. We really ought to better document this in PyVista