-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Integrate the new addons flyout into the theme #1523
Labels
Comments
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
humitos
added a commit
that referenced
this issue
Sep 13, 2023
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
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
Labels
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:
However, for our own theme, we are nicely integrating it on the bottom left together with the navbar:
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.CustomEvent
on config load addons#60The text was updated successfully, but these errors were encountered: