Docs: deprecated note about flyout integration/customization

readthedocs · Oct 10, 2023 · e3f3f7e · e3f3f7e
1 parent 50f843d
commit e3f3f7e
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/user/flyout-menu.rst b/docs/user/flyout-menu.rst
@@ -36,6 +36,15 @@ Open
 Information for theme authors
 -----------------------------
 
+.. warning::
+
+   *This is currently deprecated* in favor of the new Read the Docs Addons approach.
+   We are working on an idea that exposes all the required data to build the flyout menu via a JavaScript ``CustomEvent``.
+   Take a look at an example of this approach at https://github.com/readthedocs/sphinx_rtd_theme/pull/1526.
+
+   We are looking for feedback on this approach before making it public.
+   Please, comment on that PR or the linked issue from its description letting us know if it would cover your use case.
+
 People who are making custom documentation themes often want to specify where the flyout is injected,
 and also what it looks like.
 We support both of these use cases for themes.