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

Add automatic testing of Jupyter notebook files #376

Open
mdko opened this issue Jun 4, 2021 · 1 comment
Open

Add automatic testing of Jupyter notebook files #376

mdko opened this issue Jun 4, 2021 · 1 comment
Labels
testing For issues related to unit tests and continuous integration.

Comments

@mdko
Copy link
Contributor

mdko commented Jun 4, 2021

It would be beneficial to automatically verify that the Jupyter notebook examples still run properly at all times.

For examples, problems occur if PyRTL files are renamed or moved and no longer accessible like before if a Jupyter file depended on this submodule access. This shouldn't be a problem normally, since almost everything you'd want to use from PyRTL should accessible via pyrtl.*, but could cause problems in the future with examples that access rtllib. For example, estimate.py was recently renamed, and a PR for example7-synth-timing-draft.ipynb will be made soon to fix it.

@mdko mdko added the testing For issues related to unit tests and continuous integration. label Jun 4, 2021
@mithro
Copy link

mithro commented Jun 4, 2021

You might also want to checkout tuttest which lets you run your documentation in CI. We use it in the SymbiFlow Examples repository, see https://github.com/SymbiFlow/symbiflow-examples/blob/master/.github/scripts/install-toolchain.sh for example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
testing For issues related to unit tests and continuous integration.
Projects
None yet
Development

No branches or pull requests

2 participants