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

Fix thumbnails for notebooks on doc website #84

Closed
ninamiolane opened this issue May 23, 2023 · 2 comments
Closed

Fix thumbnails for notebooks on doc website #84

ninamiolane opened this issue May 23, 2023 · 2 comments
Labels
help wanted Extra attention is needed

Comments

@ninamiolane
Copy link
Collaborator

ninamiolane commented May 23, 2023

What?

The tutorials webpage of the documentation website does not display the thumbnails properly. We should fix this.

https://pyt-team.github.io/toponetx/tutorials/index.html

Why?

The tutorials webpage is one of the first pages that users see. It should look clean.

Where?

The nbsphinx_thumbnails dictionary could be updated in:
https://github.com/pyt-team/TopoNetX/blob/main/docs/conf.py

Alternatively, the tag nbsphinx_thumbnails could be used directly in the jupyter notebook as meta data of a cell. Note that this would override the nbsphinx_thumbnails dictionary from conf.py

There is a difficulty emerging from the fact that the notebooks are loaded in docs/tutorials through the symlink notebooks.

How?

Some information can be found on the website of nbsphinx which is the package used to create such thumbnails:
https://nbsphinx.readthedocs.io/en/0.9.1/gallery/thumbnail-from-conf-py.html

@ninamiolane ninamiolane added the help wanted Extra attention is needed label May 23, 2023
@devendragovil
Copy link
Contributor

devendragovil commented Jun 26, 2023

I found a way to enable the thumbnails. The PR #179 fixes this. However, I am trying to come up with a better method. The Symlink is indeed presenting a lot of issues.

@devendragovil
Copy link
Contributor

@mhajij @ninamiolane PR #179 has fixed this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants