Skip to content

Commit aa7df9a

Browse files
authored
Docs: deprecated note about flyout integration/customization (#10810)
1 parent 0209088 commit aa7df9a

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/user/flyout-menu.rst

+9
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,15 @@ Open
3636
Information for theme authors
3737
-----------------------------
3838

39+
.. warning::
40+
41+
*This is currently deprecated* in favor of the new Read the Docs Addons approach.
42+
We are working on an idea that exposes all the required data to build the flyout menu via a JavaScript ``CustomEvent``.
43+
Take a look at an example of this approach at https://github.com/readthedocs/sphinx_rtd_theme/pull/1526.
44+
45+
We are looking for feedback on this approach before making it public.
46+
Please, comment on that PR or the linked issue from its description letting us know if it would cover your use case.
47+
3948
People who are making custom documentation themes often want to specify where the flyout is injected,
4049
and also what it looks like.
4150
We support both of these use cases for themes.

0 commit comments

Comments
 (0)