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

Skip building example notebooks in CI via GitHub Actions #2563

Open
namurphy opened this issue Mar 8, 2024 · 0 comments
Open

Skip building example notebooks in CI via GitHub Actions #2563

namurphy opened this issue Mar 8, 2024 · 0 comments

Comments

@namurphy
Copy link
Member

namurphy commented Mar 8, 2024

PlasmaPy currently performs two doc builds in CI. One is with Read the Docs which includes a full doc preview, and the other is with GitHub Actions. I've been working to speed up the doc build done by GitHub Actions. It's down to ∼4 min!

I did some benchmarks in #2562. Skipping the execution of example notebooks would reduce doc build times by ∼30 s (and would be longer as we add more notebooks). Given how important rapid feedback is to CI, I'm currently thinking that it would be worth it to skip execution of notebooks in the GitHub Action. The RTD build would continue to execute notebooks.

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

1 participant