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 weekly GitHub Action to build docs whilst re-executing the pre-executed notebooks #2582

Open
namurphy opened this issue Mar 14, 2024 · 0 comments
Labels
documentation infrastructure GitHub Actions A continuous integration platform for automating tests and other tasks (see .github/ directory)

Comments

@namurphy
Copy link
Member

namurphy commented Mar 14, 2024

That is one way we could prevent an API call when building the docs! But I want to try and avoid that on principle since pre-executed notebooks are way more likely to get buggy/out of date.

Originally posted by @pheuer in #2570 (comment)

Following up on the comment by @pheuer, we could probably add a GitHub Action that would do a full documentation build and execute all notebooks. We currently pre-execute some of the synthetic charged particle radiography notebooks, but these can get buggy or out-of-date (as pointed out above). Having a cron job would let us figure out when things break, in particular before releases.

@namurphy namurphy added GitHub Actions A continuous integration platform for automating tests and other tasks (see .github/ directory) documentation infrastructure labels Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation infrastructure GitHub Actions A continuous integration platform for automating tests and other tasks (see .github/ directory)
Projects
None yet
Development

No branches or pull requests

1 participant