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

Improve gif animation examples #2119

Merged
merged 2 commits into from
Jan 31, 2022
Merged

Improve gif animation examples #2119

merged 2 commits into from
Jan 31, 2022

Conversation

akaszynski
Copy link
Member

@akaszynski akaszynski commented Jan 31, 2022

This PR resolves #2073 by adding a note in our Create a GIF Movie by noting that when you are using a scalar bar, it's best to turn lighting off.

Additional fixes:

  • We actually call the render pipeline 4 times in orbit() as setting the camera position and orientation triggers a render. This PR also adds a keyword argument within pyvista.Plotter to allow you to disable that.
  • Minor documentation fixes
  • Minor tweaks to the Create a GIF Movie example.
  • Ensure we save cache on the main branch.

@github-actions github-actions bot added the documentation Anything related to the documentation/website label Jan 31, 2022
@@ -15,7 +15,7 @@ on:
- '*'

env:
USE_CACHE: ${{ (github.event_name == 'workflow_dispatch' && github.event.inputs.cache == 'true') || (github.event_name == 'pull_request') }}
USE_CACHE: ${{ (github.event_name == 'workflow_dispatch' && github.event.inputs.cache == 'true') || (github.event_name == 'pull_request') || (github.event_name == 'push') }}
Copy link
Member

Choose a reason for hiding this comment

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

This would use the cache on releases, not building from scratch. I think we want to build from scratch on releases

Copy link
Member Author

Choose a reason for hiding this comment

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

This would use the cache on releases, not building from scratch

We bump the version on release, and that triggers a cache miss forcing a rebuild. We'll do that both when creating the main branch (e.g. MAJOR.MINOR.dev0), and bumping the main branch to MAJOR.MINOR.PATCH):

key: doc-_build-${{ hashFiles('pyvista/_version.py') }}-${{ hashFiles('doc/conf.py') }}

Copy link
Member

Choose a reason for hiding this comment

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

Ah, I forgot that we use the version file's hash for the cache key. Then this should be good by me!

@akaszynski akaszynski merged commit 2eeeab8 into main Jan 31, 2022
@akaszynski akaszynski deleted the doc/improve_gif branch January 31, 2022 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to the documentation/website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Jittery Scalar Bar in Saved GIF
2 participants