Skip to content

revamp tutorial structure - #6

Open
ndem0 wants to merge 1 commit into
mainfrom
tutorial-rst-format
Open

ndem0 wants to merge 1 commit into
mainfrom
tutorial-rst-format

Conversation

@ndem0

@ndem0 ndem0 commented Nov 4, 2026

Copy link
Copy Markdown
Member

No description provided.

@ndem0
ndem0 requested review from a team as code owners November 4, 2026 14:34
@ndem0
ndem0 requested a review from GiovanniCanali November 4, 2026 14:36

@GiovanniCanali GiovanniCanali left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The RST/nbsphinx approach has some issues to be addressed:

  • Notebooks have no saved outputs and execution in conf.py is disabled, so plots/results won’t appear.
  • The exporter still targets the old directory layout and generates standalone HTML.
  • All links here and in PINA must be updated again.

I prefer the existing workflow, which is already working, but I’m open to this approach if these issues are resolved and it offers tangible advantages.

@GiovanniCanali GiovanniCanali added the documentation Improvements or additions to documentation label Nov 5, 2026
@ndem0

ndem0 commented Nov 5, 2026

Copy link
Copy Markdown
Member Author

Which link do you mean?

@GiovanniCanali

Copy link
Copy Markdown
Contributor

Which link do you mean?

Those pointing to html files. For instance, there are several ones in the README.md in the list of tutorials: each tutorial points to the corresponding ipynb, py and html file.

@ndem0

ndem0 commented Nov 5, 2026

Copy link
Copy Markdown
Member Author

That's for sure, but do we have direct link from pina to a specific tutorial?

@GiovanniCanali

GiovanniCanali commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

That's for sure, but do we have direct link from pina to a specific tutorial?

I am not sure, it's worth checking. I'll soon come back with an update.

UPDATE: indeed, there are some links @ndem0.

  • in docs/source/_quickstart.rst there is a link to the first tutorial html. In my opinion it can be removed, as the file already points to the tutorial repository. Among other things, it looks like there is a minor bug with the line immediately after.
  • the html files in PINA’s docs/source/tutorials/tutorial*/ redirect to the corresponding html pages in PINA-Tutorials. Removing those destination pages would break these redirects. However, the redirect files in PINA exist only to preserve old external links. If we’re comfortable dropping support for those links, we can delete them too.

@ndem0

ndem0 commented Nov 5, 2026

Copy link
Copy Markdown
Member Author

To me, the RST files are better for online visualization
Screenshot_2026-11-05_11-37-15

Ordered left sidebar for selecting the tutorial (we can have collapsable sections or not; here, the fixed ones), right column for the content page (you can go directly to a specific section of the current notebook; you dont have to search in an html page). Colab button is still working; it is always possible to open the notebook directly.

For sure Output need to be included, I hotestly thought it was already in the notebvook

This branch has not been deployed

No deployments
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

Successfully merging this pull request may close these issues.

2 participants