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

ReadTheDocs version selector always on top for mobile displays #194

Closed
chrisjsewell opened this issue May 30, 2020 · 5 comments · Fixed by #1005
Closed

ReadTheDocs version selector always on top for mobile displays #194

chrisjsewell opened this issue May 30, 2020 · 5 comments · Fixed by #1005

Comments

@chrisjsewell
Copy link

chrisjsewell commented May 30, 2020

When hosted on ReadTheDocs, the dropdown menu that they inject is permanently on display, which is IMO not ideal.
By contrast, with the RTD theme, it is hidden in the menu bar.


Resources

Here are pointers to how the RTD theme does this:

@chrisjsewell
Copy link
Author

Whilst I'm being nit-picky, the drop-down menu could also be formatted a bit nicer: some better line spacing, and maybe a different background color, for example like the VS Code theme:


@choldgraf
Copy link
Collaborator

choldgraf commented May 30, 2020

Yeah, I'm pretty sure there's a specific HTML metadata you can add to a theme that will cause RTD to put ads there instead of in the overlay. Can't remember what it is though

(would be helpful if you opened separate issues for different comments/requests - e.g., to discuss spacing in the drop-down)

@jorisvandenbossche
Copy link
Member

specific HTML metadata you can add to a theme that will cause RTD to put ads there instead of in the overlay

I seem to also remember that this was possible for adds (but also don't directly find it ..). But what @chrisjsewell was mentioning is the "version widget". And for that I am not aware of ways to better integrate that in your custom theme.

@choldgraf
Copy link
Collaborator

choldgraf commented May 30, 2020

ah - good call, I missed that. I assume the widget should behave the same way? But maybe not. And if not, we should mention to RTD that the widget isn't very mobile-friendly. Maybe they'd allow a single-icon version for narrow screens?

@choldgraf
Copy link
Collaborator

I looked into the RTD version widget customization, and it seems like the way that they do it is to define a custom template.

It's a bit unclear to me how these two work, maybe @ericholscher could point to an explainer? I think we want to implement something like this so that we can put the RTD selector in the sidebar instead of floating in the bottom right.

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

Successfully merging a pull request may close this issue.

3 participants