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

Automatically run code blocks when building documentation in CI #1390

Open
nspope opened this issue Oct 5, 2022 · 3 comments
Open

Automatically run code blocks when building documentation in CI #1390

nspope opened this issue Oct 5, 2022 · 3 comments

Comments

@nspope
Copy link
Collaborator

nspope commented Oct 5, 2022

It's a bit tedious to go through every code block in the tutorial, check that these work, and fix them. I wonder if they could be automatically run as part of the CI. There would probably need to be some sort of caching, as the example simulations take ~10 minutes to run in some cases.

@jeromekelleher
Copy link
Member

This is one of the reasons we moved to JupyterBook for msprime/tskit etc @nspope. I don't think there is a way to run this stuff well without it - but conversion is a significant task, and examples would need to be rejigged to run in much less time (since they'll be run every time the docs are built)

@petrelharp
Copy link
Contributor

I'm happy to have a go at this at some point, as I've done it for others, but I won't get to it soon.

@nspope
Copy link
Collaborator Author

nspope commented Oct 6, 2022

Makes sense! I don't think there's a rush as the examples are up-to-date with #1391, and probably won't drift too much before 0.2.1 or whatever is next.

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

No branches or pull requests

3 participants