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

Turn off automatic notebook execution for docs builds #103

Merged
merged 1 commit into from
Sep 30, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Sep 30, 2024

Description

This PR turns off automatic notebook execution for notebooks on builds for docs. Currently this causes an error when attempting to re-run certain cells within the notebooks (showing errors within the docsite). After this change I expect the notebooks to render as-is, with the expectation that they are processed before being added to the examples.

Closes #96

What kind of change(s) are included?

  • Documentation (changes docs or other related content)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • These changes pass all pre-commit checks.
  • I have added comments to my code to help provide understanding
  • I have added a test which covers the code changes found within this PR
  • I have deleted all non-relevant text in this pull request template.

@d33bs d33bs marked this pull request as ready for review September 30, 2024 16:37
Copy link
Member

@jenna-tomkinson jenna-tomkinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Great catch that this is what was causing the issue!

@d33bs
Copy link
Member Author

d33bs commented Sep 30, 2024

Thanks @jenna-tomkinson ! Merging this in.

@d33bs d33bs merged commit 733136d into WayScience:main Sep 30, 2024
9 checks passed
@d33bs d33bs deleted the avoid-notebook-builds-for-docsite branch September 30, 2024 18:55
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

Successfully merging this pull request may close these issues.

Prevent docs example notebooks from running on build
2 participants