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.

Sign up for GitHub

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

Jump to bottom

Problem screenshots in "Using magicgui in napari" in dev #285

Closed
lucyleeow opened this issue Dec 4, 2023 · 7 comments · Fixed by #294
Closed

Problem screenshots in "Using magicgui in napari" in dev #285

lucyleeow opened this issue Dec 4, 2023 · 7 comments · Fixed by #294
Labels
bug Something isn't working

Comments

@lucyleeow
Copy link
Collaborator

lucyleeow commented Dec 4, 2023 •
edited
Loading

🐛 Bug

The screenshots in "Using magicgui in napari" in dev look squished:

image

on stable the same screenshot:

image

Note this is the worst example, the others on the page look better but still squished compared to stable.

Could it be related to #207 @aganders3 ?
@lucyleeow lucyleeow added the bug Something isn't working label Dec 4, 2023
@lucyleeow
Copy link
Collaborator Author

Actually on the same page under "Updating an existing Layer" there is a screenshot in stable but in dev there isn't even a screenshot ?

@lucyleeow lucyleeow changed the title Screenshots in "Using magicgui in napari" small in dev Problem screenshots in "Using magicgui in napari" in dev Dec 4, 2023
@aganders3
Copy link
Contributor

This feels less like it would be related to #207 than the other one, but I'll still try to take a look at both today.

@lucyleeow
Copy link
Collaborator Author

You're totally right, that was a brain fart on my end. And maybe there was a change to myst nb

@lucyleeow
Copy link
Collaborator Author

Related: #283

@psobolewskiPhD
Copy link
Member

These also appear to be fine in the CircleCI render:
https://output.circle-artifacts.com/output/job/a6aac828-d441-45bc-871d-c0ae279fd1f2/artifacts/0/docs/docs/_build/guides/magicgui.html
(this link is from latest merge to docs main)
But the zip artifact (GH runners build_docs) for #290 (https://github.com/napari/docs/actions/runs/7093485902)
has the same issue.
However, when I build locally they are fine.
So this seems to be a manifestation of the same issue as #283

@aganders3 aganders3 mentioned this issue Dec 5, 2023
Merged
@lucyleeow
Copy link
Collaborator Author

So this seems to be a manifestation of the same issue as #283

Thanks @psobolewskiPhD, I'll keep this open just for the documentation but hopefully the same fix will resolve both.

psobolewskiPhD added a commit that referenced this issue Dec 15, 2023
@aganders3 @psobolewskiPhD
Update headless-gui action in build (fix screenshots) (#294)
85636bc 
# References and relevant issues
~~Hopefully f i x e s~~ Pretty sure now this fixes both #283 and #285 

# Description
This configures the
[headless-gui](https://github.com/aganders3/headless-gui) action to not
run the tiling window manager it uses by default. My thinking is the
tiling behavior in the window manager is causing issues with certain
screenshots. See
#283 (comment) for
more details.

This also updates the action to a new version with a more common default
screen size. This change in bit-depth fixes the messed up magicgui
screenshot.

Edit: I'm still not _totally_ clear why the stable docs would look okay
but I think this is worth trying.

---------

Co-authored-by: Peter Sobolewski <[email protected]>
@psobolewskiPhD psobolewskiPhD linked a pull request Dec 16, 2023 that will close this issue
Update headless-gui action in build (fix screenshots) #294
Merged
@psobolewskiPhD
Copy link
Member

Fixed by #294

@lucyleeow lucyleeow mentioned this issue Dec 18, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update headless-gui action in build (fix screenshots) aganders3/napari-docs
3 participants
@aganders3 @lucyleeow @psobolewskiPhD