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

Test example notebooks in CI #147

Open
1 of 2 tasks
CasperWA opened this issue Sep 10, 2023 · 0 comments
Open
1 of 2 tasks

Test example notebooks in CI #147

CasperWA opened this issue Sep 10, 2023 · 0 comments
Labels
CI/CD Continuous integration (CI) & continuous deployment (CD) documentation Improvements or additions to documentation

Comments

@CasperWA
Copy link
Collaborator

CasperWA commented Sep 10, 2023

The example should be run at a part of the CI testing.

This repository already has an end-2-end test that does exactly this. No need to also run the tutorial.
That said, the mkdocs-jupyter plugin allows for executing the notebooks upon building the documentation, hence this could act as a CI test for whether the notebook works or not.
However, since a separate server is required and the notebook references localhost:80 it might be quite tricky to make it work properly. Hence, I'd consider it out-of-scope for this PR and writing this example, but definitely worth further investigation down the road.

Originally posted by @CasperWA in #125 (comment)

Notebooks:

Update: PR #127 which introduced the dlite.ipynb also added execution test for it when building the documentation.

@CasperWA CasperWA added documentation Improvements or additions to documentation CI/CD Continuous integration (CI) & continuous deployment (CD) labels Sep 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Continuous integration (CI) & continuous deployment (CD) documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant