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

Make content width adaptive to window size instead of cutting off text #63

Closed
CAM-Gerlach opened this issue Jul 3, 2018 · 3 comments · Fixed by #127
Closed

Make content width adaptive to window size instead of cutting off text #63

CAM-Gerlach opened this issue Jul 3, 2018 · 3 comments · Fixed by #127
Assignees
Labels

Comments

@CAM-Gerlach
Copy link
Member

Issue Description

Currently, our docs content (and sidebar) is a fixed width, which results in hard cutting off of the text in many scenarios, and even worse, scrolling past the edge doesn't render the missing text. This forces us to either exclude large classes of user setups/use cases from being able to view the docs properly, or use an unreasonably narrow content width.

image

The solution is to make the width of the docs content (and perhaps the sidebar, to a lesser extent) adaptive; i.e. starting at 1200 px max total width and then reducing the width and soft-wrapping the text if the window is smaller than that; also, we can pin the sidebar to one side to make the margins more even. Basically, something like this Github books output mentioned by @ccordoba12 .

Hopefully its possible to do in CSS but if not, then some simple JS perhaps. I'm guessing @dalthviz would be the one to do this?

@ccordoba12
Copy link
Member

@dalthviz, please work on this one. Take a look at how Github books work, as @CAM-Gerlach suggested.

Also, this probably requires you to add some additional Javascript to the output generated by Sphinx. I mean, I don't think this could be done with CSS alone (but I could be wrong).

@CAM-Gerlach
Copy link
Member Author

This is currently more serious than initially though, since right now thanks to the increases in the sidebar and total content width, the docs are cut off and essentially unreadable if the window width is less than 1100 px (on a portrait-format display common in software development, when split to one half of a 1080p monitor, on older monitors, on mobile devices, etc,) with no scrollbar and thus no ability to even scroll to see the missing portions on either Chrome or Firefox; the above is just how it looks when rendered locally but on our actual site there is no scrollbar at all.

This is a major issue from a usability perspective, completely breaking many likely desired use-cases. A temporary fix to at least make it usable in most of these scenarios would be reducing the total width back to 900 or 960 px as I had it (for exactly this reason), but something like what @ccordoba12 suggested with Git Books is a far better permanent solution all around.

@CAM-Gerlach
Copy link
Member Author

Fixed by PR #127

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants