Skip to content

Set up tutorial documentation - #1

Merged
GiovanniCanali merged 7 commits into
mainfrom
references
Nov 3, 2026
Merged

GiovanniCanali merged 7 commits into
mainfrom
references

Conversation

@GiovanniCanali

@GiovanniCanali GiovanniCanali commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Description

  • Update notebook/documentation links to PINA-org and the new tutorial website, keeping API links on PINA.
  • Add standalone Sphinx tutorial documentation, matching PINA’s configuration and Makefile.
  • Add documentation dependencies and update contributor, maintainer, and ownership information.
  • Generate Python and executed HTML exports through maintenance PRs.
  • Run full exports manually and weekly on Mondays, with concurrency protection.

Checklist

  • The notebook follows the tutorial guidelines — title, introduction, setup, main body, results, and a What's Next? section
  • The notebook is executable top-to-bottom within the 20 minute CI budget
  • Notebook outputs are cleared before committing
  • black . reports no changes (line length 80)
  • The entry has been added to README.md, in the right section
  • Any new dataset or image is committed, and is referenced by URL pointing
    at this repository
  • External links were checked (no mathLab/PINA/.../tutorials/ paths remain)

@GiovanniCanali GiovanniCanali changed the title Update tutorial references Set up tutorial documentation Nov 3, 2026
@GiovanniCanali
GiovanniCanali marked this pull request as ready for review November 3, 2026 11:40
@GiovanniCanali
GiovanniCanali requested a review from ndem0 November 3, 2026 11:40
@ndem0

ndem0 commented Nov 3, 2026

Copy link
Copy Markdown
Member

Can you please move all the tutorial folders into a top-level tutorials directory?

Also, do we plan to release this repo as a separate package? Maybe it doesn't seem worth it, I think it will be mainly an online resource.

@GiovanniCanali

Copy link
Copy Markdown
Contributor Author

Can you please move all the tutorial folders into a top-level tutorials directory?

Also, do we plan to release this repo as a separate package? Maybe it doesn't seem worth it, I think it will be mainly an online resource.

Sure, I will move all the tutorial folders into a single tutorials directory.

I agree that there is no clear advantage in releasing a separate standalone package for the tutorials, so I would keep the existing PINA dependencies.

However, I believe that keeping the tutorials and their documentation in a separate repository provides a cleaner structure and should reduce the overall maintenance burden across the organization.

@GiovanniCanali
GiovanniCanali merged commit c46e8b5 into main Nov 3, 2026
2 checks passed
@GiovanniCanali
GiovanniCanali deleted the references branch November 3, 2026 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants