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

Allow me to hide ver selector + redundant search bar "On RTD" row #11527

Closed
dylanh724 opened this issue Aug 8, 2024 · 2 comments
Closed

Allow me to hide ver selector + redundant search bar "On RTD" row #11527

dylanh724 opened this issue Aug 8, 2024 · 2 comments
Labels
Needed: design decision A core team decision is required

Comments

@dylanh724
Copy link

dylanh724 commented Aug 8, 2024

What's the problem this feature will solve?

I want to hide the version selector "On Read The Docs" row and the redundant "Search" row to prevent bloat:

image

Describe the solution you'd like

  • For the "On RTD" row, at first, I thought it was using cookies to detect I'm a maintainer already logged in, so injected that row in. However, in incognito, I was not pleased to see this still shows -- end users are unlikely to want to see this.
  • For the search bar, I already have a search bar at the top.

Alternative solutions

I do not want to hide it completely -- I just want the macro version selector.

Additional context

Ultimately, I just want this when popped out:

image

@humitos humitos added the Needed: design decision A core team decision is required label Aug 8, 2024
@humitos
Copy link
Member

humitos commented Aug 8, 2024

We currently don't support partial customization of the flyout. However, we expose a JavaScript CustomEvent that provides a JSON-like object with all the data required to generate a custom flyout with your needs. See readthedocs/sphinx_rtd_theme#1526 as an example of the implementation of this in the Read the Docs Sphinx theme.

Unfortunately, we don't have better documentation for this approach, but we are working on writing a guide so people can integrate this data easily.

This issue is related in some way to #11474.

@humitos
Copy link
Member

humitos commented Aug 9, 2024

On the new implementation of the flyout (using addons), the "Search" input is not shown when search addons is disabled. For the "On Read the Docs" section, we have an issue to track that work in readthedocs/addons#249. Please, subscribe there.

@humitos humitos closed this as completed Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: design decision A core team decision is required
Projects
None yet
Development

No branches or pull requests

2 participants