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

Flyout: use the new integration point #1445

Closed
wants to merge 2 commits into from

Conversation

humitos
Copy link
Member

@humitos humitos commented Mar 13, 2023

Use the documented integration point for our theme.
Read the official documentation at https://docs.readthedocs.io/en/stable/flyout-menu.html

I'm thinking about simplifying how all these integrations work and use only the ones that are documented. The idea is to inject the documented HTML tag that will be replaced by our integration at serve time.

Besides, I'm populating the template context with all the READTHEDOCS environment variables, so we can stop passing them from the Read the Docs application at build time by injecting them into the conf.py file.

Related: readthedocs/readthedocs.org#10127

@humitos humitos marked this pull request as ready for review March 21, 2023 10:36
@humitos humitos requested a review from a team as a code owner March 21, 2023 10:36
@humitos
Copy link
Member Author

humitos commented Mar 21, 2023

Besides, I'm populating the template context with all the READTHEDOCS environment variables, so we can stop passing them from the Read the Docs application at build time by injecting them into the conf.py file.

Most of these "context" variables should be converted into environment variables that all the doctool/theme authors can benefit from to integrate properly with their doctool/theme. Note this is something risen at readthedocs/readthedocs.org#9423 as well.

@humitos
Copy link
Member Author

humitos commented Sep 7, 2023

I'm closing this PR because this integrates "the old flyout" and we are moving forward with the "new flyout out" now, see #1523

@humitos humitos closed this Sep 7, 2023
@stsewd stsewd deleted the humitos/flyout-integration branch September 11, 2023 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants