Skip to content

Docs: rerun notebooks#131

Closed
mgovers wants to merge 6 commits intomainfrom
feature/rerun-notebooks
Closed

Docs: rerun notebooks#131
mgovers wants to merge 6 commits intomainfrom
feature/rerun-notebooks

Conversation

@mgovers
Copy link
Copy Markdown
Member

@mgovers mgovers commented Jan 12, 2026

The last run of the notebooks was a long time ago and some examples were actually outdated.

This PR fixes that

Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
@mgovers mgovers added the documentation Improvements or additions to documentation label Jan 12, 2026
@mgovers mgovers self-assigned this Jan 12, 2026
@mgovers mgovers requested a review from Thijss January 12, 2026 10:27
Base automatically changed from feature/add-python314-support to main January 12, 2026 11:36
Signed-off-by: Martijn Govers <martijn.govers@alliander.com>
@sonarqubecloud
Copy link
Copy Markdown

@vincentkoppen
Copy link
Copy Markdown
Member

Finally had a look at this PR an discussed with @nitbharambe about the difference in setup between PGM and PGM-DS in this regards.

We currently let readthedocs run the notebooks on each merge / PR, so this way I would prefer an notebook that has not been run in stead. Since read the docs will do it for us.
After looking into the current setup, I do see that our PR's do not error if a docs fails to run. This will be implemented with #169 (still WIP since we had a notebook that currently failed!).

Given our setup, do you still have a reason/strong preference that each notebook should be in the repo with a run state?

@vincentkoppen
Copy link
Copy Markdown
Member

Closing since we automatically run notebooks now and each PR will give an error if any of them fail. So documentation should always be up to date.

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