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.

Sign up for GitHub

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

Jump to bottom

Integrate the new addons flyout into the theme #1523

Closed
humitos opened this issue Sep 7, 2023 · 1 comment · Fixed by #1526
Closed

Integrate the new addons flyout into the theme #1523

humitos opened this issue Sep 7, 2023 · 1 comment · Fixed by #1526
Assignees
@humitos
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required

Comments

@humitos
Copy link
Member

humitos commented Sep 7, 2023

We are working on a new addons flyout (https://github.com/readthedocs/addons) that emulates the old flyout shown at the bottom right for all the themes that are not Read the Docs Sphinx theme:

Screenshot_2023-09-07_13-47-21

However, for our own theme, we are nicely integrating it on the bottom left together with the navbar:

Screenshot_2023-09-07_13-48-22

So, we would use the integration points from the new addons to write <readthedocs-flyout></readthedocs-flyout> in the navbar of this theme (or using the JSON response) and display it integrated in the same way it currently is the old one.
@humitos humitos added Needed: design decision A core team decision is required Improvement Minor improvement to code labels Sep 7, 2023
This was referenced Sep 7, 2023
Closed
Closed
humitos added a commit that referenced this issue Sep 13, 2023
@humitos
Addons: integrate with new beta addons flyout
c1ea98e 
Initial experimentation to use the `CustomEvent` triggered by the addons called
`readthedocsdataready` event (from
readthedocs/addons#64) to build the Read the Docs
flyout being integrated into the theme keeping the original look & feel.

* Related: readthedocs/addons#64
* Closes #1523
@humitos humitos mentioned this issue Sep 13, 2023
Merged
@humitos humitos self-assigned this Sep 21, 2023
@humitos humitos mentioned this issue Mar 27, 2024
Merged
@humitos
Copy link
Member Author

humitos commented Jun 3, 2024

We have been testing this in our own documentation for months now and it has been working fine. I haven't had any negative feedback about it, so I think we should be ready to move forward with discussing what are the next steps here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@humitos humitos

Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required
Projects
✨ Addons
Status: Done
📍Roadmap
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Addons: integrate with new beta addons flyout readthedocs/sphinx_rtd_theme
1 participant
@humitos