CederGroupHub / smol

Statistical Mechanics on Lattices
https://cedergrouphub.github.io/smol/
Other
64 stars 14 forks source link

Documentation issues #201

Open MarDiehl opened 2 years ago

MarDiehl commented 2 years ago

I've found the following small glitches in the documentation

https://cedergrouphub.github.io/smol/getting_started.html:

https://cedergrouphub.github.io/smol/notebooks/cluster-visualization.html:

lbluque commented 2 years ago

Hello 👋 @MarDiehl, thanks a lot for bringing these up.

I had actually not really tried the "edit this page". I'll make sure to link it correctly for our sphinx theme.

Good catch on importing Lattice, will quickly fix that too.

We do not have a download link for the notebooks, but i do think it would quite handy to have. I will look into adding this as well.

Lstly for the Crystal Toolkit dependency, I will need to contact the developers on having the rendered images show up correctly online (the images rendered nicely when I ran the cells for the notebook).

lbluque commented 2 years ago

I contacted crystal_toolkit devs, and unfortunately they mentioned rendering in sphinx documentation is not currently supported.

There seems to be interested to support this, however this will have to wait until then