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

fix: Error appearing in some examples while documentation building #944

Merged
merged 28 commits into from
Nov 29, 2024

Conversation

AlejandroFernandezLuces
Copy link
Contributor

@AlejandroFernandezLuces AlejandroFernandezLuces commented Nov 27, 2024

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.

  • It is possible that there is some incompatibility with XVFB and the code that is being run
  • There are some known issues in VTK 9.4. We are using 9.3, but we need to be wary of that.

@github-actions github-actions bot added maintenance Package and maintenance related bug Something isn't working labels Nov 27, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 27, 2024
@AlejandroFernandezLuces
Copy link
Contributor Author

Working examples in previous commit

@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Nov 29, 2024
@AlejandroFernandezLuces AlejandroFernandezLuces changed the title fix(temp): Serialize sphinx jobs fix: Error appearing in some examples while documentation building Nov 29, 2024
@AlejandroFernandezLuces AlejandroFernandezLuces marked this pull request as ready for review November 29, 2024 09:19
waltersma
waltersma previously approved these changes Nov 29, 2024
rchopade7
rchopade7 previously approved these changes Nov 29, 2024
@waltersma waltersma self-requested a review November 29, 2024 11:49
@AlejandroFernandezLuces AlejandroFernandezLuces merged commit 5038cc4 into main Nov 29, 2024
25 checks passed
@AlejandroFernandezLuces AlejandroFernandezLuces deleted the fix/doc-example-issues branch November 29, 2024 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working maintenance Package and maintenance related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants