move "RTD box" to left nav for non-default themes.

[cjw296]

Details

I was confused when I started using https://github.com/pradyunsg/furo as I couldn't see the version-picker-links-to-builds-etc box when using that theme, to the point where I put in a feature request: pradyunsg/furo#25

As @pradyunsg pointed out, I see it on the right now, but that's not where I'd expect it to be, and for some themes it ends up looking pretty ugly:

https://pip.pypa.io/en/stable/

Expected Result

The box to be in the left nav, roughly where it would be for the default theme

Actual Result

It's over on the right, where I don't expect it, and where it looks ugly on themes which have a left nav, which I would hazard a guess to be all of them.

[humitos]

I'm not sure where we are adding this, but I think this should be configurable.

[pradyunsg]

readthedocs.org/readthedocs/core/static-src/core/js/doc-embed/footer.js

Line 79 in a81d82e

injectFooter(data);

The relevant point in code.

[pradyunsg]

FWIW, Furo now does place this correctly in the sidebar, although it needed reading of sponsorship.js here, and a bunch more investigation.

Here is how stuff looks with the development documentation for pip (big file, screenshot):

The tracking issue for the mismatched colors is readthedocs/ethical-ad-client#37

[pradyunsg]

Oh, and here's what was the tracking issue for this on Furo's end: pradyunsg/furo#23

[pradyunsg]

Oh, unless we're talking about the hover box thingie -- in which case, WHOOPS, coz I was talking about the ads. :)

[cjw296]

Yep, hover box thingy, which I think your screenshot still shows off on the right, whereas the RTD theme has it on the left, which I think it belongs...

[pradyunsg]

@cjw296 Ah, I assume you mean the sidebar.

That's non-trivial for the embedding JS here (which applies to all of ReadTheDocs) to implement while still respecting any designs that themes could have (eg: only right sidebars like Sphinx's own documentation). I expect Furo to get the relevant styling for RTD settled down at some point, but that's not today. :)

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[cjw296]

This is still an issue.

[stsewd]

As mentioned, we do this because there is no guarantee that all themes will have a sidebar that fits the version chooser. We are planning in make it more easy to integrate, so theme authors can choose where and how to place it. See #7748