Skip to content

Conversation

@M-Lampert
Copy link
Contributor

@M-Lampert M-Lampert commented Nov 10, 2025

This PR validates, fixes and improves the documentation:

  • We make all Jupyter Tutorials run independently without file dependencies from the PathpyG repo
    • Some datasets that were only locally available(ants and email-company) are replaced by similar datasets from netzschleuder.
    • For datasets, where replacement was not possible, e.g. the synthetic dataset for the DB-GNN tutorial (docs/data/temporal_clusters.tedges), we added a snippet that automatically downloads the dataset from the repo if it is not found locally.
  • Tutorial notebooks are now automatically executed during deployment and tested as part of the CI when a PR is opened.
  • Code reference is updated and extended.
  • Added tests for docstring examples
  • All linting and static type checking errors have been fixed. The linting and static type-checking CI workflows have now been set to fail on error.

@M-Lampert M-Lampert linked an issue Nov 10, 2025 that may be closed by this pull request
@M-Lampert M-Lampert marked this pull request as ready for review November 12, 2025 13:56
@M-Lampert M-Lampert merged commit e8fa280 into main Nov 12, 2025
5 checks passed
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.

Validate reference documentation and tutorials

2 participants