search

scipp / copier_template

Copier template for Scipp projects
BSD 3-Clause "New" or "Revised" License
2 stars 1 forks source link

Change theme page width? #119

Closed SimonHeybrock closed 5 months ago

SimonHeybrock commented 6 months ago

Some docs could benefit from using more screen space, see, e.g., screenshot: screenshot-2023-12-14T11:57:46

This can apparently be adjusted in the theme: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html#horizontal-spacing. Should we make a global change to 100%, or does this hurt readability?

jl-wynen commented 6 months ago

100% would make it hard to read text because the lines become very long.

I agree that sometimes, pages are too narrow. But in your example, no screen is wide enough to really make it readable. I think the current graph layout just doesn't scale the way we need it to.

SimonHeybrock commented 6 months ago

I think the current graph layout just doesn't scale the way we need it to.

I disagree: If we more than double the width this would be way more readable. Does it solve all problems? No. Would it make it somewhat usable? I think so.

YooSunYoung commented 6 months ago

I agree. If it makes text less readable, we can just add more line breakers, <br>, no...?

SimonHeybrock commented 6 months ago

Users can change their width of their browser window?

jl-wynen commented 6 months ago

I agree. If it makes text less readable, we can just add more line breakers, <br>, no...?

No, this way, we couldn't rely on automatic line wrapping which currently adjusts the lines to the browser window.

I disagree: If we more than double the width this would be way more readable. Does it solve all problems? No. Would it make it somewhat usable? I think so.

Yes, it would help. But it seems to me like it just kicks the can down the road.

SimonHeybrock commented 6 months ago

I disagree: If we more than double the width this would be way more readable. Does it solve all problems? No. Would it make it somewhat usable? I think so.

Yes, it would help. But it seems to me like it just kicks the can down the road.

I would argue that even if you implement zooming or anything fancy, any non-trivial graph will be unreadable with the current width. Therefore: Not kicking anything down the road, I feel this is required regardless of solving related issues of graph display.

nvaytet commented 6 months ago

I agree with @jl-wynen that very long lines of text are more difficult to read than thicker paragraphs.

I have a feeling that people working on the theme have thought very long and hard about these kind of issues (also so it works on different platforms such as tablets or phones), and it is highly likely that any attempt at changing this will probably make it worse rather than better? They have probably thought about how to make it look harmonious with plots etc...

I think that changing the width for all our docs because we don't have a good solution for the graphs is maybe trying to tackle the problem the wrong way? Right now, I'm fine with right-clicking and opening the graph into a new tab to look at it better.

SimonHeybrock commented 5 months ago

After reverting a problematic change in Sciline this is no longer a major issue.