Version toggler and feedback dropdown look odd

[amotl]

@msbt reported a visual regression.

Quick FYI: I realized earlier that the version toggler and feedback dropdown on the docs look odd and while debugging, figured out that there was an update of one of the packages that we have in use (https://github.com/executablebooks/sphinx-design/tags). This update/regression caused the layout to fail.

[amotl]

@msbt figured the regression has been caused by sphinx-design-0.6.0, released just five days ago.

Other than investigating about which kind of changes to CSS rules might have caused the regression, he suggested to downgrade to sphinx-design<0.6 in the meanwhile, in order to work around that problem.

[msbt]

thanks @amotl, this seems to be the corresponding patch, where they change from chevron up/down to right/down: executablebooks/sphinx-design#192

[amotl]

Thanks. I can't spot the regression you outlined at https://cratedb.com/docs/crate/reference/ and friends. May I ask you to elaborate where it is visible?

[msbt]

@amotl along those lines https://github.com/executablebooks/sphinx-design/pull/192/files#diff-aa63b0bb1f95ed68c20ca762bcff0c773ac1c9394680fbbe0f4c7417d41540b5L61-L80 this is where the chevrons change

[amotl]

I totally accept and appreciate that you spotted an error. However, it is not visible for me in any way. Maybe you can support this case by referring to a spot where we can also see it?

Within the OP, there is just a screenshot, but no reference to a corresponding spot.

[amotl]

I am asking because a downgrade to a previous version of sphinx-design would be totally a no-brainer, like outlined at #497 (comment).

However, because I can't spot any regression anywhere, I am doubting that it makes sense, because it will not make too much of a difference from my perspective.

[matkuliak]

One thing to mention for anyone working on this, @msbt was able to patch this by injecting CSS with HubSpot - via fastly edge side includes, from what I understand.

[amotl]

Ah I see. Now it totally makes sense that I can't spot any mistake, if it has already been fixed using a workaround. Thanks for clarifying.

[msbt]

@amotl you can see the regression on any non-proxied url, e.g. https://crash.readthedocs.io/en/latest/

So the padding changed and also the chevrons

[amotl]

Now, everything makes sense. Thanks for clarifying.

NB: Please don't use linkable URLs verbatim in public which can feed crawlers wrongly.

[amotl]

Because sphinx-design 0.6 also trips software tests on sphinx-design-elements, and because I currently don't have the capacity to review and fix them, I am already downgrading on behalf of sphinx-design-elements, release pending.

• Chore: Update development and runtime dependencies tech-writing/sphinx-design-elements#84

[amotl]

sphinx-design-elements v0.3.2 downgrades to sphinx-design v0.5, so the next downstream builds of crate-docs-theme should pick up corresponding package versions, effectively resolving this issue.

Please verify, report back, and/or close this issue, all at your disposal. Thanks.

[amotl]

• I've rebuilt all docs, and purged the Fastly cache on all documentation projects afterwards.
• Sampling a single RTD build, it apparently properly pulls in sphinx-design-elements-0.3.2, and, more importantly, sphinx-design 0.5.0. See also https://readthedocs.org/projects/cratedb-guide/builds/24518613/.

[amotl]

@amotl you can see the regression on any non-proxied url, e.g. https://crash.readthedocs.io/en/latest/. The padding changed and also the chevrons.

It looks like it is fixed through the downgrading outlined above.

[amotl]

I just found that in the changelog for sphinx-design 0.6:

The "default" behaviour of the right chevron is to go from right-facing (closed) to down-facing (open), instead of down-facing (closed) to up-facing (open). There is also a rotate transition on opening/closing. The old default behaviour can be retained by using the new :chevron: down-up directive option.

[amotl]

We concluded the resolution of this flaw by adding relevant fixes and releasing crate-docs-theme 0.33.0. @msbt: Thanks for your support!

[msbt]

@amotl apparently the docs are still being built with the old version (Downloading crate_docs_theme-0.32.4-py3-none-any.whl (2.1 MB)) - any idea what's going on there?

[amotl]

Build #24863053 on "crash" says it uses crate-docs-theme-0.33.0 already. If you can provide a reference to where it's different, I can look into it.

[msbt]

@amotl that was back when the 0.33.0 wasn't on pyi