DIsable the version component in RTD

[renardeinside]

Details

• Read the Docs project URL: https://readthedocs.org/projects/dbx/
• Build URL (if applicable): N/A
• Read the Docs username (if applicable): N/A

Expected Result

A description of what you wanted to happen

No version overlay in my project (component with class rst-current-version.

Actual Result

Since some time ago the following version overlay appeared (e.g. here):

I would like to be able to disable it. Project docs are made with mkdocs-material.

[stsewd]

Hi! You can change the position of the flyout menu, or hide it using CSS, see https://docs.readthedocs.io/en/stable/flyout-menu.html.

[cbrnr]

@stsewd could you please be more specific on how to hide it? The linked documentation doesn't mention this explicitly.

I would happily leave the flyout menu on my site if it was working – currently, it is rendered but clicking on it has no effect (see https://sleepecg.readthedocs.io/en/stable/).

[humitos]

@cbrnr

I would happily leave the flyout menu on my site if it was working – currently, it is rendered but clicking on it has no effect (see sleepecg.readthedocs.io/en/stable).

I think it's because the flyout depends on jQuery and you are using Material for MkDocs theme that does not include it. You could manually include jQuery in your project to make it work properly.

We are working on better integration with Material for MkDocs that will solve this problem in the near future.

[cbrnr]

Thank you @humitos! I'm looking forward to a better integration with Material! Meanwhile, if I do not want to include jQuery, can the flyout be disabled or hidden without much hassle?

[chester-leung]

Hi @humitos , do you have any estimated timeline on the integration with Material for MkDocs? Thank you.

[humitos]

Hi @chester-leung! The integrations with Material for MkDocs is already in our roadmap, so hopefully it will be done in 2023 Q1.

[cbrnr]

And what about disabling for now?

[chester-leung]

@cbrnr there is a workaround for this here. I tested this and it seems to work!

[humitos]

Great! I'm happy that you found a solution to inject jQuery on Material for MkDocs. We are already working on a better integration with Material for MkDocs and we won't be assuming that jQuery is already loaded in the near future. I'm closing this issue, but feel free to open a new one if you find any other problem 👍🏼