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

Version selector not working in 2.1.0rc1 #11520

Open
dylanh724 opened this issue Aug 7, 2024 · 4 comments
Open

Version selector not working in 2.1.0rc1 #11520

dylanh724 opened this issue Aug 7, 2024 · 4 comments
Labels
Needed: more information A reply from issue author is required

Comments

@dylanh724
Copy link

dylanh724 commented Aug 7, 2024

I don't believe this one needs too many details: If you RTD build with 2.1.0rc1 in any scenario, your bottom-left version selector will be missing.

Just a heads up! Downgrading back to 2.0.0 fixed it.

Sphinx 7.4.7

@humitos
Copy link
Member

humitos commented Aug 7, 2024

Hi @dylanh724 👋🏼 . Do you have Read the Docs Addons enabled on your project? https://docs.readthedocs.io/en/stable/addons.html#enabling-read-the-docs-addons

Note that we are in the middle of a transition (https://about.readthedocs.com/blog/2024/07/addons-by-default/), and I think you are hitting the expected behavior here: no flyout with the latest rc version of the theme and without addons enabled.

Can you confirm us if it does work as expected when using 2.1.0rc1 and having the addons enabled in your project?

I don't believe this one needs too many details

What's the URL of your project on Read the Docs?

@humitos humitos added the Needed: more information A reply from issue author is required label Aug 7, 2024
@dylanh724
Copy link
Author

Hi,

  • I can confirm that in v2.0.0, enabling the flyout brings the version selector back (floating).
  • Going back to v2.1.0rc1 and following your guide, it now shows both the bottom-left version selector and the flyout:

image

I'm going to assume if I turn off flyout, all will be resolved (just needed that addon enabled? I would've had no clue whew).

https://docs.xsolla.cloud/en/latest/

This is the live site that has the rc1 theme with NO version selector (expected bottom-left selector), before I activated the addon instructions (I haven't rebuilt).

What's interesting is that you can actually see where the bottom-left version selector is supposed to be. If you scroll down the sticky navbar, you can see the chunk of space reserved for it:

GIF

@humitos
Copy link
Member

humitos commented Aug 8, 2024

Going back to v2.1.0rc1 and following your guide, it now shows both the bottom-left version selector and the flyout:

This is the expected behavior for now. We are working on a PR that will allow users to disable the flyout from the theme and only leave the addons flyout or vice-versa.

@humitos
Copy link
Member

humitos commented Aug 14, 2024

We just released 2.1.0rc2 that adds a theme option flyout_display. By default it's hidden, so you won't have 2 flyouts when building on Read the Docs and having addons enabled. @dylanh724 Can you please give it a try and confirm it's working fine for you?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: more information A reply from issue author is required
Projects
None yet
Development

No branches or pull requests

2 participants