generated from ansys/template
-
Notifications
You must be signed in to change notification settings - Fork 9
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
fix: Error appearing in some examples while documentation building #944
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
maintenance
Package and maintenance related
bug
Something isn't working
labels
Nov 27, 2024
github-actions
bot
added
the
documentation
Improvements or additions to documentation
label
Nov 27, 2024
Working examples in previous commit |
github-actions
bot
removed
the
documentation
Improvements or additions to documentation
label
Nov 29, 2024
AlejandroFernandezLuces
changed the title
fix(temp): Serialize sphinx jobs
fix: Error appearing in some examples while documentation building
Nov 29, 2024
waltersma
previously approved these changes
Nov 29, 2024
rchopade7
previously approved these changes
Nov 29, 2024
AlejandroFernandezLuces
dismissed stale reviews from rchopade7 and waltersma
via
November 29, 2024 09:45
ce0402f
rchopade7
approved these changes
Nov 29, 2024
waltersma
approved these changes
Nov 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This should fix the error that appears in some of the examples while building the documentation. Fixed by commenting out some plotting related code, and updating the PyVista dependency.
Also seized the oportunity to add closure management of the docker image when there is an unexpected exit.
Important
Github is being messy with the diffs, the only modified example is example 10, and it was modified only in two plotting sections.
Error description
Each of the examples work fine outside Sphinx context. Also, each of the examples work if they are the only example being built in Sphinx. For some unknown reason, some examples fail due to the early closure of its prime service.
Error seems to be related to the visualizer/pyvista/VTK, although it is not clear why an error there would cause the closure of the prime service. Also, it is a silent failure in the visualization part.