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

Migrate to readthedocs "addons" #3672

Closed
wolfgangwalther opened this issue Jul 31, 2024 · 3 comments
Closed

Migrate to readthedocs "addons" #3672

wolfgangwalther opened this issue Jul 31, 2024 · 3 comments
Labels
docs Only related to documentation

Comments

@wolfgangwalther
Copy link
Member

Readthedocs migrates the menu in the lower left to something else called "addons".

See:

I tried to enable addons and built the docs in a PR, but that didn't go too well. The readthedocs menu appeared as an overlay in the lower right, on top of the "switch to dark mode" button.

There is some mention of:

We released a new version of our theme to keep the flyout menu at the bottom left integrated with the navbar that you can install it as sphinx-rtd-theme==2.1.0rc1.

and we currently have:

sphinx-rtd-theme>=0.5.1

So we might just need to update this and then see how it goes.

@wolfgangwalther wolfgangwalther added the docs Only related to documentation label Jul 31, 2024
@wolfgangwalther
Copy link
Member Author

Seems like this has silently hit us by now, because I have this in our docs in the lower right:

20241029-175222-491404388

@wolfgangwalther
Copy link
Member Author

I disabled the "flyout addon" in the readthedocs settings. This is now just not there anymore. We still have the version selector and the search at the top left. I don't think we are missing anything in that flyout menu.

@steve-chavez @laurenceisla agreed?

@laurenceisla
Copy link
Member

Yes, I think it's OK with just the version selector. This should also fix #3240

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Only related to documentation
Development

No branches or pull requests

2 participants