Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation issues #201

Open
MarDiehl opened this issue May 9, 2022 · 2 comments
Open

Documentation issues #201

MarDiehl opened this issue May 9, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@MarDiehl
Copy link

MarDiehl commented May 9, 2022

I've found the following small glitches in the documentation

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

  • "Edit this page gives a 404".
  • First example needs to import Lattice
  • It would be handy to have a link to download the notebooks (I might have overlooked it)

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

  • Missing dependency: "If you see this text, the Crystal Toolkit Jupyter Lab extension is not installed."
@MarDiehl MarDiehl added the bug Something isn't working label May 9, 2022
@lbluque
Copy link
Collaborator

lbluque commented May 11, 2022

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
Copy link
Collaborator

lbluque commented May 19, 2022

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

@lbluque lbluque mentioned this issue Jul 18, 2022
@lbluque lbluque added documentation Improvements or additions to documentation and removed bug Something isn't working labels Jan 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants