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

Split flyout integration into different selectors #1587

Open
humitos opened this issue Aug 9, 2024 · 2 comments · May be fixed by #1616
Open

Split flyout integration into different selectors #1587

humitos opened this issue Aug 9, 2024 · 2 comments · May be fixed by #1616
Assignees
Labels
Improvement Minor improvement to code

Comments

@humitos
Copy link
Member

humitos commented Aug 9, 2024

We've been talking about splitting the integration of the flyout into different selectors/blocks and place them outside the flyout. In fact, the concept of the flyout may not apply anymore for Sphinx theme after moving this information outside the current flyout -- leaving the concept of flyout only to the one injected by Read the Docs addons.

Using CPython as an example, the version and language selectors could be placed at the top left, below the project's logo/name:

Screenshot_2024-08-09_16-12-54

Besides, the "On Read the Docs" section from the original flyout could be moved to the footer:

Screenshot_2024-08-09_16-13-09

These are just examples, but I think it reflects how theme authors will integrate with us in a better way without the following the flyout concept.

Related: readthedocs/addons#51

@humitos humitos added the Needed: design decision A core team decision is required label Aug 9, 2024
humitos added a commit that referenced this issue Oct 8, 2024
@humitos humitos linked a pull request Oct 8, 2024 that will close this issue
@humitos
Copy link
Member Author

humitos commented Oct 8, 2024

The selectors were already implemented in #1601. The only missing part is mentioning "Hosted on Read the Docs". I opened a PR for this at #1616

@humitos humitos added Improvement Minor improvement to code and removed Needed: design decision A core team decision is required labels Oct 8, 2024
@humitos humitos self-assigned this Oct 8, 2024
@humitos humitos moved this to Needs review in 📍Roadmap Oct 8, 2024
@humitos
Copy link
Member Author

humitos commented Nov 4, 2024

OK. I'm moving this issue out from the current roadmap, since it's not a huge priority and there is more work than I expected here.

@humitos humitos removed this from 📍Roadmap Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants
@humitos and others