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

WIT flowchart is rendering long and skinny in sphinx docs #1106

Open
BexDunn opened this issue Aug 7, 2023 · 3 comments
Open

WIT flowchart is rendering long and skinny in sphinx docs #1106

BexDunn opened this issue Aug 7, 2023 · 3 comments
Labels
bug Something isn't working

Comments

@BexDunn
Copy link
Collaborator

BexDunn commented Aug 7, 2023

WIT flowchart is rendering long and skinny in sphinx docs.

Docs rendering is showing up different to notebook rendering. The html controlling the size of the image in the notebook needs adjusting so the image is readable in the docs.

Steps to reproduce

  1. Go to https://docs.dea.ga.gov.au/notebooks/DEA_products/DEA_Wetlands_Insight_Tool.html
    witrender

Expected behaviour
image

Environment information
DEA Sandbox and Chrome to view the docs

@BexDunn BexDunn added the bug Something isn't working label Aug 7, 2023
@robbibt
Copy link
Collaborator

robbibt commented Aug 7, 2023

Oh that's weird. Could try resizing the image file itself to the right width, then just rendering it using plain markdown? e.g.

![](*.jpg)

@BexDunn
Copy link
Collaborator Author

BexDunn commented Aug 7, 2023

Here's a question - do we know what the 'right width' is for a jupyter notebook, given different screen rendering and sizes? A quick search of stackexchange suggests using the Image module from IPython.display could be a good option https://stackoverflow.com/questions/41598916/resize-the-image-in-jupyter-notebook-using-markdown -however it's an old post, so I'm not sure what the most recent solution would be..

@robbibt
Copy link
Collaborator

robbibt commented Aug 7, 2023

I think if you use the markdown approach it will just scale it correctly by default - I don't think I've needed to specify a specific width/height using that method in the past. E.g. just looking at a notebook like this where we have a few images, which all seem to be rendering OK to the width of the notebook (the table is worse though!)

https://docs.dea.ga.gov.au/notebooks/Beginners_guide/02_DEA.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants