Add an explicit flyout placement option #9357
Conversation
This PR does a few things: * Lets themes define a `#readthedocs-embed-placement` element, where we will inject the footer * Documents the flyout menu under Advanced Features Refs pydata/pydata-sphinx-theme#705
docs/user/flyout-menu.rst
Outdated
| HTML themes can style the flyout to make it match the overall style of the HTML. | ||
| By default the flyout has it's `own CSS file <https://github.com/readthedocs/sphinx_rtd_theme/blob/master/src/sass/_theme_badge.sass>`_, | ||
| which you can look at to see the basic CSS class names. | ||
| It also uses fontawesome to define some basic UI elements, |
There was a problem hiding this comment.
| It also uses fontawesome to define some basic UI elements, | |
| It also uses Font Awesome to define some basic UI elements, |
There was a problem hiding this comment.
There is a PR opened to remove this and hardcode only the icons used. So, this may conflict with that. See #9297
There was a problem hiding this comment.
I'll go ahead and remove this mention for now, so we don't have to remember to remove it. That does seem like a better approach.
There was a problem hiding this comment.
Note: Font Awesome isn't being removed, just the need for font files. It's still a Font Awesome licensed graphic.
docs/user/flyout-menu.rst
Outdated
| HTML themes can style the flyout to make it match the overall style of the HTML. | ||
| By default the flyout has it's `own CSS file <https://github.com/readthedocs/sphinx_rtd_theme/blob/master/src/sass/_theme_badge.sass>`_, | ||
| which you can look at to see the basic CSS class names. | ||
| It also uses fontawesome to define some basic UI elements, |
There was a problem hiding this comment.
There is a PR opened to remove this and hardcode only the icons used. So, this may conflict with that. See #9297
|
This isn't a blocker, but a future feature request -- would it be possible to make the CSS styling of the flyout not get injected, if a certain attribute is set on the object? This could look like adding an additional class on the element injected in that case, and scoping the styles to a |
|
@pradyunsg Yea, I just had a conversation with @agjohnson, and he suggested using |
|
That sounds great! :) |
|
What can I do to help this get landed and deployed, so that the various active downstream themes can switch to this? :) |
|
FYI: The PR description needs to be updated to reflect the implementation (which uses |
|
@pradyunsg Going to merge this and deploy it tomorrow 👍 |
|
@pradyunsg This should now be live, but I haven't heavily tested it other than ensuring it injects properly. Please let me know if it's working for you! |
|
@ericholscher I just realized that the example used in the documentation does not have translations. I think it would be good to improve the example by adding translations so theme authors have a full flyout example and can style it properly. What do you think? |
|
@humitos Sounds good to me 👍 I just copied an existing style, but we should definitely be documenting (and probably have an example) of the full possible content. |
This PR does a few things:
#readthedocs-embed-flyoutelement, where we will inject the footerRefs pydata/pydata-sphinx-theme#705