From 9539ae9263026949a2cd4943854187dfefe883a4 Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 11 Nov 2024 13:51:57 +0100 Subject: [PATCH] Clarify flyout options (#11750) Fix up for the new options on this old PR. --- :books: Documentation previews :books: - User's documentation (`docs`): https://docs--11750.org.readthedocs.build/en/11750/ - Developer's documentation (`dev`): https://dev--11750.org.readthedocs.build/en/11750/ Co-authored-by: Manuel Kaufmann --- docs/user/intro/sphinx.rst | 24 ++++++------------------ 1 file changed, 6 insertions(+), 18 deletions(-) diff --git a/docs/user/intro/sphinx.rst b/docs/user/intro/sphinx.rst index 4767770bfae..7cbf34a3ab8 100644 --- a/docs/user/intro/sphinx.rst +++ b/docs/user/intro/sphinx.rst @@ -101,28 +101,16 @@ If you're using a different theme, enable :doc:`Server side search `__, the :ref:`flyout-menu:Addons flyout menu` is already fully integrated into the theme. Use the theme options `flyout_display `__, `version_selector `__, `language_selector `__ to configure it. - If you're using the `Read the Docs Sphinx Theme `__, the :ref:`flyout-menu:Addons flyout menu` is already fully integrated. +- If you're using another theme, the flyout menu displays in the bottom right of the docs. - You *may* need to set `flyout_display` to `hidden `_ in your ``conf.py`` so as not to display two identical menus: - - .. code-block:: py - :caption: conf.py - - html_theme_options = { - "flyout_display": "hidden", - } - - If you're using a different theme, the flyout menu will display in the default bottom right side of your docs. +In either case, you can configure the flyout menu sorting and display options in :guilabel:`Settings`, under :guilabel:`Addons`. Using Markdown with Sphinx --------------------------